Skip to content

Add release documentation #1338

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 3 commits into from
Jul 6, 2018
Merged

Conversation

JakeGinnivan
Copy link
Contributor

@JakeGinnivan JakeGinnivan commented Dec 5, 2017

@gep13 @asbjornu @Jericho

When this release process was created, a few of the manual steps couldn't be automated. There may be ways to improve

2. Paste the downloaded release notes in, you can clean them up if you want otherwise there may be closed issues which were questions etc.
3. Tick the pre-release box if it's pre-release
4. Press Publish
1) Publishing tags (a git tag) the release commit, this will trigger another appveyor build which only builds tags, this build uses deploy.cake. It downloads the artifacts from that GitHub release, then performs the release
Copy link
Member

Choose a reason for hiding this comment

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

I don't really understand this point. Isn't the tag automatically created through publishing the GitHub release (point before)? Are there additional tags which needs to be created?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Will clarify in the docs.

We push a non published github release, so it doesn't create a tag. The tag is created when you publish the release from the GitHub site

Copy link
Member

Choose a reason for hiding this comment

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

That's my confusion. In 4. Press Publish of the above point the tag will be created. Why does it need another step to create tags? Or is this just the explanation that the publish above does create tags (in this case IMHO it should be part of point 4. above), or should point 4 above be saving as draft instead of publish?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sorry, AppVeyor creates a draft, I wanted to call out that publish at this point creates the tag and that runs the build

@asbjornu
Copy link
Member

asbjornu commented Dec 8, 2017

Can't we auto-publish releases from AppVeyor without any manual steps? Builds without a tag can get a pre-release label and builds with a tag are considered stable releases. Wouldn't that work?

@JakeGinnivan
Copy link
Contributor Author

We can auto publish, but I don't know how to automate the release notes part of it..

Also the release notes require manual intervention most of the time :(

Happy for us to change what is setup, this is just documenting the current setup

@asbjornu
Copy link
Member

asbjornu commented Dec 9, 2017

Can't we use GitReleaseManager or similar to at least sketch out release notes so they can be manually edited on GitHub? I've never gotten it to work in my repos, but I assume someone must know how to get it to work?

@JakeGinnivan
Copy link
Contributor Author

Not with appveyor deployments afaik, we can't run tools in that step.

We could put it in the actual deployment steps though

@asbjornu
Copy link
Member

We could instrument that through Cake, no?

@JakeGinnivan
Copy link
Contributor Author

Yeah probably, the release notes are probably not good enough quality to just be used, but can edit after the fact if so. Happy for it to be updated as I said :)

@asbjornu
Copy link
Member

asbjornu commented Mar 9, 2018

Is the release note part of this something you can help add, @gep13? It would be so nice to get this and a more automated build pipeline in so we can release this more consistently. I'm a bit ashamed of the state of the project now, tbh. 😞

What I would like is an automatic beta-release for every merge to master and then a stable release with automatic release-creation on Github if the built commit is tagged. Just getting beta packages out the door frequently and consistently would be awesome.

@JakeGinnivan
Copy link
Contributor Author

We could just go back to the drawing board with the release process. Completely up to you guys :)

@ovebastiansen
Copy link

Any chance you also can upload beta versions as preview version into vsts extensions? Right now its a bit hard to use the beta version in vsts.

@asbjornu
Copy link
Member

asbjornu commented Apr 5, 2018

@ovebastiansen: If we redo the release process a bit, like I propose above (#1338 (comment)), beta-releases should be published to all possible package sources every time we merge to master. If you can help out with that, it'd be great!

@ovebastiansen
Copy link

@asbjornu, sry there has been way to much stuff happening lately.
How stuck are you on the current setup? I am mostly familiar with vsts (have not used cake yet) and this writeup seems promising https://oren.codes/2018/05/15/oss-build-and-release-with-vsts/
The build system can still use github for code and build whenever any thing is checked into here, but adding the Release parts in vsts might get us somewhere we want to be, regarding automating stuff.

Copy link
Member

@gep13 gep13 left a comment

Choose a reason for hiding this comment

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

LGTM!

@gep13 gep13 merged commit c7c0332 into GitTools:master Jul 6, 2018
@asbjornu asbjornu mentioned this pull request Jul 24, 2018
14 tasks
@JakeGinnivan JakeGinnivan deleted the document-release branch July 28, 2018 02:24
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.

5 participants