openzeppelin-contracts icon indicating copy to clipboard operation
openzeppelin-contracts copied to clipboard

Published 20 hours ago • verified publisher icon OpenZeppelin

Add `RELEASING.md` docs

Open ernestognw opened this issue 1 year ago • 1 comments

Description

Added docs about #3915

PR Checklist

  • [x] Documentation

ernestognw avatar Jan 19 '23 23:01 ernestognw

⚠️ No Changeset found

Latest commit: 14326a659d4611e06b6e8f60ae7cab604d47ac7c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

changeset-bot[bot] avatar Jan 19 '23 23:01 changeset-bot[bot]

I've simplified the RELEASING.md to remove implementation details about the release process. For implementation details we should make sure that the release-cycle.yml scripts are well documented.

Personally I find this flowchart to be the main useful thing, it would be nice to include it in a comment in release-cycle.yml but we'd need to draw it in ASCII.

graph LR
  Development -->|D| RC-Unreleased -->|M| RC-Released -->|D| Final-Unreleased -->|M| Final-Released
  RC-Released -->|C| RC-Unreleased
  Final-Released -->|C| Final-Unreleased

frangio avatar Feb 10 '23 22:02 frangio

I've simplified the RELEASING.md to remove implementation details about the release process. For implementation details we should make sure that the release-cycle.yml scripts are well documented.

Personally I find this flowchart to be the main useful thing, it would be nice to include it in a comment in release-cycle.yml but we'd need to draw it in ASCII.

Well, I was hoping it was added if I put it in the comments. I tried.

Anyway, I was wondering what is the problem with putting it in the comments and having a link to mermaid.live? I think it's still better developer experience.

ernestognw avatar Feb 10 '23 23:02 ernestognw

I was wondering what is the problem with putting it in the comments and having a link to mermaid.live?

It's not a bad idea. ASCII art diagram might be simpler though.

frangio avatar Feb 11 '23 02:02 frangio

I was wondering what is the problem with putting it in the comments and having a link to mermaid.live?

It's not a bad idea. ASCII art diagram might be simpler though.

Let's keep it in ASCII

ernestognw avatar Feb 11 '23 21:02 ernestognw