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

cargo release helper #790

Closed
wants to merge 7 commits into from
Closed

cargo release helper #790

wants to merge 7 commits into from

Conversation

igalic
Copy link
Contributor

@igalic igalic commented Jun 21, 2020


how to use?

cargo release --dry-run --workspace minor

and also add overrides in all other crates, since we only have one
CHANGELOG.md: crate-ci/cargo-release#205
we might wanna have that looked at or fixed
@igalic igalic mentioned this pull request Jun 21, 2020
@codecov
Copy link

codecov bot commented Jun 21, 2020

Codecov Report

Merging #790 into main will increase coverage by 0.01%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #790      +/-   ##
==========================================
+ Coverage   39.09%   39.10%   +0.01%     
==========================================
  Files          73       73              
  Lines        9756     9758       +2     
  Branches     2233     2233              
==========================================
+ Hits         3814     3816       +2     
- Misses       4885     4887       +2     
+ Partials     1057     1055       -2     

@igalic
Copy link
Contributor Author

igalic commented Jun 21, 2020

uh… will we need to add it as development dependency?

release.toml Outdated
{file="CHANGELOG.md", search="\\.\\.\\.dev", replace="...{{tag_name}}", exactly=1},
{file="CHANGELOG.md", search="ReleaseDate", replace="{{date}}"},
{file="CHANGELOG.md", search="<!-- next-header -->", replace="<!-- next-header -->\n\n## [Unreleased] - ReleaseDate", exactly=1},
{file="CHANGELOG.md", search="<!-- next-url -->", replace="<!-- next-url -->\n[Unreleased]: https://github.com/assert-rs/predicates-rs/compare/{{tag_name}}...HEAD", exactly=1},
Copy link
Member

Choose a reason for hiding this comment

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

Shouldn't the repo URL be changed here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

how?

Copy link
Member

Choose a reason for hiding this comment

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

To something like https://github.com/Plume-org/Plume/compare/{{tag_name}}...HEAD, so that the changelog links to our commit history.

Copy link
Member

Choose a reason for hiding this comment

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

Also, is there a <!-- next-url --> somewhere in the changelog you added? I can't find it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

i didn't add it to our current changelog

@elegaanz
Copy link
Member

Also, maybe we could unify the headers in the changelog to follow what https://keepachangelog.com/ recommends, to keep it coherent.

And for the development dependency, I don't think so. It should be documented here that people who want to publish a new release should use this tool tho.

@igalic
Copy link
Contributor Author

igalic commented Jun 22, 2020

n. b. : i've back-filled the changelog by copy-pasting the text from our github releases page

for the future of the changelog, i absolutely agree

@elegaanz
Copy link
Member

I know you copied what is on GitHub, but maybe we could change this text? Would it be a problem to have texts that are a bit different on Github and in the changelog? I would prefer to have the whole changelog have the same format (but that's arguable).

@elegaanz
Copy link
Member

Also, could it be possible to add pre-release-hook to run crowdin pull (I don't remember the exact arguments, but basically : the command to pull the latest version of translations)? Or do you think it should be done manually before running cargo release?

@igalic
Copy link
Contributor Author

igalic commented Jun 22, 2020

I know you copied what is on GitHub, but maybe we could change this text? Would it be a problem to have texts that are a bit different on Github and in the changelog? I would prefer to have the whole changelog have the same format (but that's arguable).

the only problem was time and energy
y'all have access to write to this PR, so, please, by all means, help me!!

Also, could it be possible to add pre-release-hook to run crowdin pull (I don't remember the exact arguments, but basically : the command to pull the latest version of translations)? Or do you think it should be done manually before running cargo release?

that's a very good idea!

how do i make it work?

◆ plume git:(fix/cargo-release-helper) ❯❯❯ crowdin pull
Project key is empty
✖ 1 plume git:(fix/cargo-release-helper) ❯❯❯ 

@elegaanz
Copy link
Member

I don't remember how the Crowdin CLI works, I'll check that and edit the PR. I'll also edit the changelog.

@elegaanz
Copy link
Member

So the translations should be pulled now, if you have a CROWDIN_API_KEY in your env. We should remember to document how to get one before making a release.

@igalic
Copy link
Contributor Author

igalic commented Jun 23, 2020

So the translations should be pulled now, if you have a CROWDIN_API_KEY in your env. We should remember to document how to get one before making a release.

let's create a doc issue right now, and link it here

@elegaanz
Copy link
Member

Plume-org/docs#88

@igalic
Copy link
Contributor Author

igalic commented Jun 24, 2020

what about docker?

@elegaanz
Copy link
Member

I think the release should be automatic, I'll check.

@elegaanz
Copy link
Member

It is not, I'll a hook.

@elegaanz
Copy link
Member

elegaanz commented Jun 24, 2020

The thing is, the docker tag needs to be pushed after the git tag, and there is no post-release-hook in cargo release, apparently.

So maybe we can document that this has to be done manually, and do it by hand for the moment?

@igalic
Copy link
Contributor Author

igalic commented Jun 24, 2020

or we could add docker tag to the CI build process, only on tag

@igalic
Copy link
Contributor Author

igalic commented Jun 25, 2020

yunohost relies on docker, right?
and it's one of the platforms that we recommend, thru our installation guide

@elegaanz
Copy link
Member

It doesn't, it uses Bash scripts. I'm not sure if it is better tho… 😅

@igalic
Copy link
Contributor Author

igalic commented Jul 4, 2020

we should open a pr or issue to release a new version on Yunohost after the release?

@KitaitiMakoto
Copy link
Contributor

That's good!

@elegaanz elegaanz changed the base branch from master to main July 5, 2020 16:19
@igalic igalic deleted the fix/cargo-release-helper branch December 6, 2020 19:26
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