Skip to content
  • Sponsor
  • Notifications You must be signed in to change notification settings
  • Fork 169

doc: update PUBLISHING.md #959

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 1 commit into from
Nov 14, 2023
Merged

Conversation

phip1611
Copy link
Member

@phip1611 phip1611 commented Oct 10, 2023

UPDATE According to the latest discussions and developments, I'm updating the guide again.

rendered

Old Version

After publishing uefi-raw and uefi, I noticed that the PUBLISHING.md was a bit cumbersome to follow. I simplified things in a way where I think it is more useful and consise for everybody. What do you think?

For example:

I removed some (from my perspective) obvious paragraphs. For example if uefi-raw has a
publicly exported breaking change (such as a new MSRV), then bumping it in uefi is of
course a breaking change too. I don't think I need to remind ourselves for such "obvious" stuff. Do you agree?

I'm open for your opinions! @GabrielMajeri @nicholasbishop

Checklist

  • Sensible git history (for example, squash "typo" or "fix" commits). See the Rewriting History guide for help.
  • Update the changelog (if necessary)

Sorry, something went wrong.

@phip1611 phip1611 force-pushed the publishing branch 8 times, most recently from e26adea to f261039 Compare October 10, 2023 16:56
@GabrielMajeri
Copy link
Collaborator

I noticed that the PUBLISHING.md was a bit cumbersome to follow. I simplified things in a way where I think it is more useful and consise for everybody. What do you think?

I think it's great that this document is also getting some attention! I've created it initially when Nicholas joined as a co-maintainer in order to record what I was more-or-less doing for each release. It was clear that it could be improved, but it's hard to determine what's not obvious when you're already familiar with the process.

@phip1611
Copy link
Member Author

phip1611 commented Nov 2, 2023

Yikes, forgot about this. Will work on it soon.

@phip1611 phip1611 self-assigned this Nov 2, 2023
@phip1611 phip1611 force-pushed the publishing branch 2 times, most recently from eb8096a to 9d2c6ba Compare November 14, 2023 12:20
@phip1611 phip1611 force-pushed the publishing branch 2 times, most recently from a87a55c to cb76a22 Compare November 14, 2023 12:24
@phip1611
Copy link
Member Author

rendered

@phip1611
Copy link
Member Author

I hope the new version is fine

@nicholasbishop nicholasbishop added this pull request to the merge queue Nov 14, 2023
Merged via the queue into rust-osdev:main with commit 06c300e Nov 14, 2023
@phip1611 phip1611 deleted the publishing branch July 14, 2024 06:58
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.

None yet

3 participants