Skip to content
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

Update process docs to reflect recent changes to release process #14091

Merged
merged 1 commit into from May 6, 2021

Conversation

sbc100
Copy link
Collaborator

@sbc100 sbc100 commented May 4, 2021

As discussed the new plan is to have the version stored on
main reflect the next upcoming, but unreleased, version of
emscripten. This matches, for example, llvm where the git
users see version N+.

The hope is that this means that we can tag that exact commit
that goes into an emsdk releases rather than the next commit,
and it should avoid tree closures.

docs/process.md Outdated Show resolved Hide resolved
Copy link
Member

@dschuff dschuff left a comment

Choose a reason for hiding this comment

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

I guess what's not documented here yet is the expectation that we'll be creating the candidate builds manually (or via a script) with a CL in emscripten-releases. But that doesn't need to be in this PR, and this process can just as easily be used to release non-LTO builds.

docs/process.md Outdated Show resolved Hide resolved
docs/process.md Outdated Show resolved Hide resolved
Current Trunk
-------------
2.0.20
------
Copy link
Member

Choose a reason for hiding this comment

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

It would be good to mention that from here the value in emscripten-version.txt in git is forward-looking etc.

I feel like we should document this elsewhere too - perhaps on the "developer guide" page on the website?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I added a description to the ChangeLog. I honestly can't think of any use case that might be effected by this? At least none of our processes were. I'm not sure who it would benefit to document this outside of where we already have.

Copy link
Member

Choose a reason for hiding this comment

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

The risk is low, I agree. But one possible issue is people bisecting on the emscripten repo and looking at the version file as they go. I think it's useful to mention that file's meaning has changed at this time.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I have mentioned it in this ChangeLog entry.. do you think I should mention it in the bisect instructions too?

Copy link
Member

Choose a reason for hiding this comment

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

Maybe not needed in bisection. The docs there focus on multirepo bisection, which this should not affect.

If there is confusion we can update the docs accordingly later.

Ask discussed the new plan is to have the version stored on
`main` reflect the next upcoming, but unreleased, version of
emscripten.   This matches, for example, llvm where the git
users see version N+.

The hope is that this means that we can tag that exact commit
that goes into an emsdk releases rather than the next commit,
and it should avoid tree closures.
Current Trunk
-------------
2.0.20
------
Copy link
Member

Choose a reason for hiding this comment

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

The risk is low, I agree. But one possible issue is people bisecting on the emscripten repo and looking at the version file as they go. I think it's useful to mention that file's meaning has changed at this time.

@sbc100
Copy link
Collaborator Author

sbc100 commented May 6, 2021

Maybe I'll shoot a PSA to the mailing list..

@sbc100 sbc100 merged commit fe9f67f into main May 6, 2021
@sbc100 sbc100 deleted the new_process branch May 6, 2021 15:06
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