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 publish-new-version.sh for pushing versions of the crate #217

Merged
merged 8 commits into from
Sep 17, 2020

Conversation

acmcarther
Copy link
Member

Adds a script for publishing new versions of this crate to codify my shell history into a shell script usable by other folks.

Has some rudimentary checks for the existence of cargo and that the working directory is clean.

r: @UebelAndre as well

@acmcarther acmcarther requested a review from damienmg September 15, 2020 06:03
@acmcarther acmcarther mentioned this pull request Sep 15, 2020
@acmcarther acmcarther changed the title Add push-new-version.sh for pushing versions of the crate Add publish-new-version.sh for pushing versions of the crate Sep 15, 2020
@UebelAndre
Copy link
Collaborator

@acmcarther Are there also some examples of using this script? Whenever I add things like this to projects at work, I typically add a block of comments at the top of the file that show simple usage just to make it crystal clear as to what to do.

# Use the script like so
# Args: ...docs...
#
# ./my_script.sh arg1 arg2
# Use the script like so
# Environment: ...docs...
#
# ARG_VAR=1 ./my_other_script.sh

Things like that.

While It's unlikely I'll be doing a deploy for this so If there's some internal Google doc that has this, that works as well. The thing I want to avoid is all maintainers who have familiarity with the project/script being unavailable and therefore no more releases happen because maybe some constraint changed or things are not as obvious to the available/new maintainers.

Whether or not you decide to do that, I'm thankful for this PR! 😄

@acmcarther
Copy link
Member Author

Thanks, that's valuable feedback.

I've added some documentation about what the script does and how to use it to the top of the file. Incidentally, I've also updated the mechanism it uses to take in the new version from an environment variable to a regular argument.

@UebelAndre
Copy link
Collaborator

@acmcarther When the version is updated should the Cargo.lock file be updated too in the /tools directory?

@acmcarther
Copy link
Member Author

Re #217 (comment)

I'm not really sure. I don't consider the contents of tools/ to be part of the package proper though, so i think it's OK to punt on this question for now.

That said, this should be a consideration in handling #210 I think.

@acmcarther acmcarther merged commit 69f45d0 into master Sep 17, 2020
@UebelAndre
Copy link
Collaborator

As a quick followup. Do you think you could delete some old branches? 😅

@acmcarther acmcarther deleted the acm-push-new-version branch September 17, 2020 19:41
@acmcarther
Copy link
Member Author

Done!

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.

3 participants