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

chore(ci): Enable preview and stable deployments #5178

Merged
merged 9 commits into from
Apr 19, 2024

Conversation

PeterSchafer
Copy link
Collaborator

@PeterSchafer PeterSchafer commented Apr 18, 2024

Pull Request Submission

Please check the boxes once done.

The pull request must:

  • Reviewer Documentation
    • follow CONTRIBUTING rules
    • be accompanied by a detailed description of the changes
    • contain a risk assessment of the change (Low | Medium | High) with regards to breaking existing functionality. A change e.g. of an underlying language plugin can completely break the functionality for that language, but appearing as only a version change in the dependencies.
    • highlight breaking API if applicable
    • contain a link to the automatic tests that cover the updated functionality.
    • contain testing instructions in case that the reviewer wants to manual verify as well, to add to the manual testing done by the author.
    • link to the link to the PR for the User-facing documentation
  • User facing Documentation
    • update any relevant documentation in gitbook by submitting a gitbook PR, and including the PR link here
    • ensure that the message of the final single commit is descriptive and prefixed with either feat: or fix: , others might be used in rare occasions as well, if there is no need to document the changes in the release notes. The changes or fixes should be described in detail in the commit message for the changelog & release notes.
  • Testing
    • Changes, removals and additions to functionality must be covered by acceptance / integration tests or smoke tests - either already existing ones, or new ones, created by the author of the PR.

Pull Request Review

All pull requests must undergo a thorough review process before being merged.
The review process of the code PR should include code review, testing, and any necessary feedback or revisions.
Pull request reviews of functionality developed in other teams only review the given documentation and test reports.

Manual testing will not be performed by the reviewing team, and is the responsibility of the author of the PR.

For Node projects: It’s important to make sure changes in package.json are also affecting package-lock.json correctly.

If a dependency is not necessary, don’t add it.

When adding a new package as a dependency, make sure that the change is absolutely necessary. We would like to refrain from adding new dependencies when possible.
Documentation PRs in gitbook are reviewed by Snyk's content team. They will also advise on the best phrasing and structuring if needed.

Pull Request Approval

Once a pull request has been reviewed and all necessary revisions have been made, it is approved for merging into
the main codebase. The merging of the code PR is performed by the code owners, the merging of the documentation PR
by our content writers.

What does this PR do?

With this PR we are starting to deploy to different deployment channels (preview, candidate, stable/latest). The channels have been introduced before but were containing all the same deployment until now.

With this PR, continuous deployments that have so far been available via latest are now available via preview. Preview effectively serves as staging deployment and will be at regular points in time be promoted to candidate which will after stabilization be promoted to stable, which is an alias for latest.

Risk: Low to Medium as it affects the deployments but should not break anything.

Release Channels availability:

Where should the reviewer start?

How should this be manually tested?

Any background context you want to provide?

What are the relevant tickets?

Screenshots

Additional questions

@PeterSchafer PeterSchafer changed the title Chore/cli 149 enable stable release chore(ci): Enable preview and stable deployments Apr 18, 2024
@PeterSchafer PeterSchafer marked this pull request as ready for review April 18, 2024 13:57
@PeterSchafer PeterSchafer requested a review from a team as a code owner April 18, 2024 13:57
@PeterSchafer PeterSchafer force-pushed the chore/CLI-149_enable_stable_release branch from 27d700b to 00e64a7 Compare April 18, 2024 15:42
@PeterSchafer PeterSchafer force-pushed the chore/CLI-149_enable_stable_release branch from 00e64a7 to 1eb633c Compare April 18, 2024 16:51
Copy link
Contributor

@cmars cmars left a comment

Choose a reason for hiding this comment

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

LGTM, nonblocking question below

Makefile Show resolved Hide resolved
@PeterSchafer PeterSchafer enabled auto-merge (squash) April 19, 2024 08:13
@PeterSchafer PeterSchafer merged commit dcce4d4 into main Apr 19, 2024
15 checks passed
@PeterSchafer PeterSchafer deleted the chore/CLI-149_enable_stable_release branch April 19, 2024 08:50
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.

2 participants