Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add GitLab CI/CD support #135

Merged
merged 9 commits into from
Apr 1, 2024
Merged

add GitLab CI/CD support #135

merged 9 commits into from
Apr 1, 2024

Conversation

erral
Copy link
Member

@erral erral commented Mar 28, 2024

I have added a .gitlab-ci.yml file to provide deployment configuration for those using GitLab CI/CD.

I have also added a README explaining how to configure it.

- Renamed to a fully-spelled name
- Use the now preferred for several years ED25519 SSH key, instead of RSA
- Mostly style guide formatting, grammar, and MyST that is tedious to go through a review cycle
Copy link
Member

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of going through a tedious docs review cycle, I just committed my review. The only question I have is whether we're on the same page to use the now for several years preferred ED25519 SSH keys instead of RSA.

@erral
Copy link
Member Author

erral commented Mar 29, 2024

No problem on documenting how to create ED25519 keys. But we are creating RSA keys for the deployment...

@stevepiercy
Copy link
Member

@erral OK, but should we use RSA or ED25519 going forward? My sysadmin required that I regenerate my SSH keys to use ED25519 for our GitLab instance. I assume this is now a best practice, as the GitLab docs say this is the way forward for now.

@erral
Copy link
Member Author

erral commented Mar 29, 2024

OK. I will update my PR to document how to use EDD25519 keys.

I will add a new PRto create and use those keys by default.

@stevepiercy
Copy link
Member

I already added the commands for ED25519 keys in my commit to this PR. Please take a look, and let me know if it needs revision.

@erral
Copy link
Member Author

erral commented Mar 30, 2024

I already added the commands for ED25519 keys in my commit to this PR. Please take a look, and let me know if it needs revision.

The changes are OK!

@erral
Copy link
Member Author

erral commented Mar 30, 2024

@stevepiercy I have added a note in the section where I suggest to create a new SSH key, saying that one can reuse the one created by the server setup command.

Copy link
Member

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we also need to update a couple of other files.

README.md under Project Generation Options:

| `github_organization` | Used for GitHub and Docker repositories.                                                                                                             | **collective**                |

to:

| `github_organization` | Used for GitHub, GitLab, and Docker repositories.                                                                                                    | **collective**                |

https://github.com/collective/cookiecutter-plone-starter/blob/main/cookiecutter.json#L99

    "github_organization": "GitHub Username or Organization",

to:

    "github_organization": "GitHub or GitLab Username or Organization",

Copy link
Member

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oxford comma

Copy link
Member

@stevepiercy stevepiercy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, but let's get review from @plone/ci-team and maybe @ericof and @jensens.

Copy link
Member

@ericof ericof left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, but we should add tests to this feature (but I will open an issue about testing)

@ericof ericof merged commit ab3150a into main Apr 1, 2024
5 checks passed
@ericof ericof deleted the erral-gitlab-support branch April 1, 2024 20:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants