Skip to content

Update documentation step for the release process #3158

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

Merged
merged 3 commits into from
Feb 24, 2025

Conversation

ADubhlaoich
Copy link
Contributor

@ADubhlaoich ADubhlaoich commented Feb 21, 2025

Proposed changes

User-facing documentation was migrated to the main NGINX documentation repository. This commit changes the instructions and tooling configuration to reflect what has changed.

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

Release notes

If this PR introduces a change that affects users and needs to be mentioned in the release notes,
please add a brief note that summarizes the change.


User-facing documentation was migrated to the main NGINX documentation
repository. This commit changes the instructions and tooling
configuration to reflect what has changed.
@ADubhlaoich ADubhlaoich requested review from a team as code owners February 21, 2025 15:10
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Feb 21, 2025
@ADubhlaoich
Copy link
Contributor Author

ADubhlaoich commented Feb 21, 2025

Beyond the scope of updating the release process documentation, I'm gonna double-check if the guidance around contributing mentions the documentation repository and how branch management works. I

t's relatively straightforward, but still crucially important - especially since only the team will be involved with releases, whereas anyone could be contributing to documentation at any time.

@ADubhlaoich
Copy link
Contributor Author

The documentation repository will be protecting release branches with the pattern name <product>-release-<version>: noting it here is not necessary within the scope of the release process, but means we can assert exactly how the new release branch should be named.

@ADubhlaoich ADubhlaoich requested a review from sjberman February 21, 2025 16:32
@ADubhlaoich ADubhlaoich merged commit 2d5f21d into nginx:main Feb 24, 2025
38 checks passed
@ADubhlaoich ADubhlaoich deleted the docs/update-process-action branch February 24, 2025 12:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants