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

Update release guidelines #546

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update release guidelines #546

wants to merge 1 commit into from

Conversation

viniciusdc
Copy link
Contributor

@viniciusdc viniciusdc commented Nov 21, 2024

Reference Issues or PRs

What does this implement/fix?

Put a x in the boxes that apply

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds a feature)
  • Breaking change (fix or feature that would cause existing features not to work as expected)
  • Documentation Update
  • Code style update (formatting, renaming)
  • Refactoring (no functional changes, no API changes)
  • Build related changes
  • Other (please describe):

Testing

  • Did you test the pull request locally?
  • Did you add new tests?

Documentation

Access-centered content checklist

Text styling

  • The content is written with plain language (where relevant).
  • If there are headers, they use the proper header tags (with only one level-one header: H1 or # in markdown).
  • All links describe where they link to (for example, check the Nebari website).
  • This content adheres to the Nebari style guides.

Non-text content

  • All content is represented as text (for example, images need alt text, and videos need captions or descriptive transcripts).
  • If there are emojis, there are not more than three in a row.
  • Don't use flashing GIFs or videos.
  • If the content were to be read as plain text, it still makes sense, and no information is missing.

Any other comments?

Copy link

netlify bot commented Nov 21, 2024

Deploy Preview for nebari-docs ready!

Name Link
🔨 Latest commit cfe9fd8
🔍 Latest deploy log https://app.netlify.com/sites/nebari-docs/deploys/673f5481e2839a0009aeb8ff
😎 Deploy Preview https://deploy-preview-546--nebari-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@viniciusdc viniciusdc marked this pull request as ready for review November 21, 2024 15:52
Copy link
Contributor Author

@viniciusdc viniciusdc left a comment

Choose a reason for hiding this comment

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

self-review with missing items to complete

Comment on lines +98 to +103
:::note
Hotfix releases are rare and are only used to address critical issues that cannot wait
for the next scheduled release, they are usually associated with
[broken](https://conda-forge.org/docs/maintainer/updating_pkgs/#removing-broken-packages)
or [yanked](https://pypi.org/help/#yanked) releases. And should be delivered as soon as possible.
:::
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Need to include dedicated section about broken releases, and how to proceed in each mirror

Comment on lines +48 to 49
For example, the first Nebari CalVer release was `2022.10.1`. If a hotfix were needed in the same month, you would increment the `releaseNumber` by 1 to get `2022.10.2`. (_Note: This is just an illustration; this release does not actually exist._)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This needs to be rewritten since that's not how calver works

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Todo 📬
Development

Successfully merging this pull request may close these issues.

1 participant