Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Update release procedure documentation #1414

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
per1234 merged 2 commits into arduino:main from per1234:update-release-process
Sep 8, 2022
Merged

Update release procedure documentation #1414

per1234 merged 2 commits into arduino:main from per1234:update-release-process
Sep 8, 2022

Conversation

Copy link
Contributor

@per1234 per1234 commented Sep 8, 2022

Motivation

An internal release procedure document was created separately from the documentation hosted in this repository. That internal document became significantly more comprehensive and up to date than the unmaintained documentation in this repository.

The current situation results either in the burden of maintaining two copies of the same information, or more likely the out of sync state between the information in the two resulting from lack of such maintenance.

Change description

A single document will be maintained here in this repository from now on. The superior version of the information from the internal document is migrated to the repository.

Other information

The documentation is moved from the previous inappropriate location in BUILDING.md to a dedicated file docs/internal/release-procedure.md


Supersedes the alternative proposal at #1408

Reviewer checklist

  • PR addresses a single concern.
  • The PR has no duplicates (please search among the Pull Requests before creating one)
  • PR title and description are properly filled.
  • Docs have been added / updated (for bug fixes / features)

Previously, the procedure for creating a new release of the project was included in the development documentation.
This information is distinct from the rest of the contents of that file in that it is not of any value or interest to
most contributors from the community since only project maintainers will ever create a release. This meant that it make
the document less readable and approachable without adding significant value in return.
The information is still essential to the project maintainers, so it must not be removed, but it can be moved to a
dedicated file under the existing `docs/internal/` folder that is specifically intended for storing such information.
@per1234 per1234 added topic: documentation Related to documentation for the project type: enhancement Proposed improvement labels Sep 8, 2022
@per1234 per1234 self-assigned this Sep 8, 2022
Copy link
Contributor

@kittaakos kittaakos left a comment

Choose a reason for hiding this comment

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

Thank you!

Copy link
Contributor

@AlbyIanna AlbyIanna left a comment

Choose a reason for hiding this comment

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

LGTM!
Thanks @per1234 for taking care of this ❤️

An internal release procedure document was created separately from the documentation hosted in this repository. That
internal document became significantly more comprehensive and up to date than the unmaintained documentation in this
repository.
In order to avoid either the burden of maintaining two copies of the same information, or more likely the out of sync
state between the information in the two resulting from lack of such maintenance, a single document will be maintained
here in this repository.
The superior version of the information from the internal document is hereby migrated to the repository where it will be
maintained from here on.
@per1234 per1234 merged commit 565970e into arduino:main Sep 8, 2022
@per1234 per1234 deleted the update-release-process branch September 8, 2022 20:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
2 more reviewers

@kittaakos kittaakos kittaakos approved these changes

@AlbyIanna AlbyIanna AlbyIanna approved these changes

Reviewers whose approvals may not affect merge requirements
Labels
topic: documentation Related to documentation for the project type: enhancement Proposed improvement
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /