search

elasticdog / transcrypt

transparently encrypt files within a git repository
MIT License
1.46k stars 102 forks source link

Preparations for the next release #84

Closed jmurty closed 4 years ago

jmurty commented 4 years ago

This PR is to collect and review any changes needed to prepare for the next transcrypt release.

TODOs:

@elasticdog please add or amend these TODOs so I can help out where I can.

elasticdog commented 4 years ago

That makes sense to me...I think it would be good to start putting changes into a legit CHANGELOG.md file so it's not just in the GitHub release notes (or README).

Beyond that, it's updating the docs and references like you mentioned, bumping the version, signing a tag, and then pushing it to mark a release. If you like, I can handle the signing step once you're ready, but my basic process looks like this:

$ export GPG_TTY=$(tty)

This will tag and sign a release via GPG:

$ git tag -s v0.9.4 -m 'Release v0.9.4'

...the signature can be verified if you have the proper public key in your GPG keyring with:

$ git tag -v v0.9.4

You can see a tagged release with:

$ git show v0.9.4

Push your annotated tags to the remote repo with:

$ git push --tags
stherold commented 4 years ago

Hey there, when can we expect this PR to be merged roughly? For us it would be cool when https://github.com/elasticdog/transcrypt/pull/76 makes it into a new release :-)

jmurty commented 4 years ago

Hi @stherold we're moving slowly towards a release but we don't have a specific timeline in mind.

Be aware that you don't need to wait for an official release to take advantage of the fix in #76, you can download and use the transcrypt script file from the master branch and run it directly.

Here's the raw file link to the current transcrypt on master: https://raw.githubusercontent.com/elasticdog/transcrypt/master/transcrypt

stherold commented 4 years ago

Yup that's what I communicated in our team. This is also fine for now. Thanx fr the info :-)

jmurty commented 4 years ago

Hi @elasticdog I think everything in this PR is now up-to-date and we should be pretty close to being able to release version 2.1.0, assuming that's what you want to tag it?

Can you please look over the changes here, especially the new CHANGELOG.md file and any new documentation or notes I have added, to make sure they are clear and correct?

jmurty commented 4 years ago

You're welcome @elasticdog, thanks for checking the changes.

I have pushed improvements to always use double brackets [[ ]] in transcrypt itself and in the tests, since it's worth it to gain any extra safety we can in bash world. I must have been confused when I added a TODO item for the relevant comment and got it backwards in the description of this PR.

I think it would be best to leave the contexts work to settle instead of rushing it into the 2.1.0 release, since I haven't used it at all myself day-to-day and I'm still finding rough edges and bugs in https://github.com/elasticdog/transcrypt/pull/89

jmurty commented 4 years ago

@elasticdog I have squash-merged this branch to master without the contexts work on #63.

Let's release!

Blackjacx commented 4 years ago

Wasn't this PR intended for the 2.0.0 release?

jmurty commented 4 years ago

Version 2.0.0 is already out: https://github.com/elasticdog/transcrypt/releases/tag/v2.0.0

[Edit] I mean, it has been out for a long time.

Blackjacx commented 4 years ago

yeah I just noted down that this should be merged too for us to switch from the development (commit) version to a new tag. But since that was long ago I forgot why ^^

elasticdog commented 4 years ago

Sorry, I missed the original ping saying that this was merged and ready to go. I just cut a release...thanks again @jmurty!

jmurty commented 4 years ago

Thanks for releasing @elasticdog !