search

ably / specification

The Ably features spec for client library SDKs.
Apache License 2.0
0 stars 4 forks source link

Document Release Process #121

Closed QuintinWillison closed 1 year ago

QuintinWillison commented 1 year ago

Expanding on the repository-specific guidance established in https://github.com/ably/specification/pull/120, incorporating reference to the estate-wide guidance established by https://github.com/ably/engineering/pull/44 and https://github.com/ably/engineering/pull/45, responding to @lawrence-forooghian's comment:

I think that knowing how the release process works might help answer some questions that this raised for me about how the future process of developing the features spec would work.

For example, a feature spec writer who is removing a feature spec point is instructed to write It was valid up to and including specification version @X.Y@. It's not very clear to me where I would get this X.Y version from - it depends on whether I'm working on a branch on which the specification version hasn't been bumped yet (in which case I get the version from the meta.yaml file on my branch), or on a branch on which the specification version has already been bumped (in which case I'm not sure where I'd get the version from), which ultimately depends on the branching and release strategy for the repo.

Similarly, if a writer makes a change to the feature spec that necessitates a major / minor / patch version change, do they make that version bump in their PR or does that happen at the end of some sort of release process?

sync-by-unito[bot] commented 1 year ago

➤ Automation for Jira commented:

The link to the corresponding Jira issue is https://ably.atlassian.net/browse/SDK-3126

QuintinWillison commented 1 year ago

Despite my opening "closes" comment on the linked PR and the fact that the linked PR was acknowledged to close this issue, GitHub still failed to close this issue when that pull request merged. So I'm doing it now.