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

Add changelog.txt and readme.txt to GitHub repository #18828

Merged

Conversation

@jorgefilipecosta
Copy link
Member

jorgefilipecosta commented Nov 29, 2019

Description

Closes: #6004
Sometimes we want to merge a change that requires an update to changelog.txt and readme.txt e.g: #16674.
Having the files here allows us to in a single PR/commit change something and update these files.

The release tool was updated, as now we also need to update these files on Github.

How has this been tested?

I used a Gutenberg fork to test the Git iteractions available at https://github.com/jorgefilipecosta/gutenberg (with the test changes made still there).

I used a free svn repository powered by riouxsvn.com to test the svn iteractions.

] );
await simpleGit.commit( 'Update stable tag version to ' + version );
await simpleGit.push( 'origin', 'master' );
console.log( '>> Stable version updated successfully on the git repository' );

This comment has been minimized.

Copy link
@youknowriad

youknowriad Dec 4, 2019

Contributor

I feel this should be done beforehand in the Git repository in the early steps of the process (when bombing the Gutenberg version in the git repo). Same for the changelog.

I guess it will result in a simpler SVN flow: commit once and then tag but I believe this works too right?

This comment has been minimized.

Copy link
@jorgefilipecosta

jorgefilipecosta Dec 4, 2019

Author Member

I feel this should be done beforehand in the Git repository in the early steps of the process (when bumping the Gutenberg version in the git repo). Same for the changelog.

Hi @youknowriad,
If we do that, we need to update the stable tag on git, create the zip file, and then before committing to svn, we would need to revert the stable tag update because at the time we update the svn the tag does not exist yet.

This comment has been minimized.

Copy link
@youknowriad

youknowriad Dec 4, 2019

Contributor

Interesting, it makes me wonder if we can simplify things a bit more and maybe omit entirely the stable tag from the Git version of the file and only add it on SVN?

This comment has been minimized.

Copy link
@jorgefilipecosta

jorgefilipecosta Dec 6, 2019

Author Member

Hi @youknowriad thank you for sharing your thoughts :)

Interesting, it makes me wonder if we can simplify things a bit more and maybe omit entirely the stable tag from the Git version of the file and only add it on SVN?

To not have the stable tag on the GitHub repository, but add it on svn in a reliable way, we would need a mark on the file to mark the zone where the tag should be added. Something: like "Stable tag: V.V.V".
So after extracting the zip from the GitHub repository into svn, we would need change on the version from V.V.V to the real one, similar to what would happen if we followed your first suggestion where we changed it from the version we will release into the current version that is available.
I think both options are ok although I expect they require a little bit more code than this one. Let me know what is your preference and I will update the code in accordance.

This comment has been minimized.

Copy link
@youknowriad

youknowriad Dec 6, 2019

Contributor

I like the placeholder approach.

This comment has been minimized.

Copy link
@jorgefilipecosta

jorgefilipecosta Dec 6, 2019

Author Member

I updated this PR to the placeholder approach.

@jorgefilipecosta jorgefilipecosta force-pushed the add/changelog-and-readme-to-github-repository branch from b5f7b11 to 453f6c0 Dec 6, 2019
Copy link
Contributor

youknowriad left a comment

Let's try it in the next release

@jorgefilipecosta jorgefilipecosta merged commit 992a9d4 into master Dec 9, 2019
2 checks passed
2 checks passed
pull-request-automation
Details
Travis CI - Pull Request Build Passed
Details
@jorgefilipecosta jorgefilipecosta deleted the add/changelog-and-readme-to-github-repository branch Dec 9, 2019
@youknowriad youknowriad added this to the Gutenberg 7.1 milestone Dec 9, 2019
@bobbingwide

This comment has been minimized.

Copy link
Contributor

bobbingwide commented Dec 9, 2019

Did you forget to fix the typos in the change log?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.