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

gitignore sensitive files used for publishing releases #3266

Merged
merged 1 commit into from Jun 25, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions publish/.gitignore
@@ -0,0 +1,4 @@
Makefile
global.sbt
sonatype.sbt
.credentials
2 changes: 1 addition & 1 deletion publish/Makefile → publish/Makefile.template
@@ -1,6 +1,6 @@
IMG := geotrellis/publish-geotrellis-container
TAG := latest
RELEASE_TAG := v3.0.0
RELEASE_TAG := vX.Y.Z
GEOTRELLIS_VERSION_SUFFIX := ""
PGPKEYS_PATH := ~/.gnupg
CREDENTIALS_PATH := ~/.ivy2
Expand Down
22 changes: 17 additions & 5 deletions publish/README.md
Expand Up @@ -6,22 +6,32 @@ since we had lot's of issues with conflicting sbt versions / gpg version / etc.

## Setup

First, copy the example `Makefile` and `global.sbt` templates:
```
cp Makefile.template Makefile
cp global.sbt.template global.sbt
```

You'll need to have the proper Sonatype credentials in `./sonatype.sbt`:

```scala
realm=Sonatype Nexus Repository Manager
host=oss.sonatype.org
user=username
password=password
```

The proper PGP public and private key in `~/.gnupg` (or in any other directory, see `Makefile`).
The passphrase for the private key (for jar signing) in `./global.sbt`:
Then, make sure you update `CREDENTIALS_PATH` in the Makefile to point to this directory.

Add the proper PGP public and private key to `~/.gnupg` (or to any other directory, see `Makefile`). If you need these keys, contact a GeoTrellis maintainer.

Edit the passphrase for the private key (for jar signing) in `./global.sbt`. If you need the passphrase, contact a GeoTrellis maintainer:

```scala
pgpPassphrase := Some(Array('p', 'a', 's', 's', 'w', 'o', 'r', 'd'))
```

And a `./gpg.sbt` that looks like:
Ensure that `./gpg.sbt` that looks like:

```scala
addSbtPlugin("com.jsuereth" % "sbt-pgp" % "1.1.1")
Expand All @@ -48,7 +58,7 @@ IMG := geotrellis/publish-geotrellis-container
# docker image default tag
TAG := latest
# GeoTrellis release tag
RELEASE_TAG := v3.0.0
RELEASE_TAG := vX.Y.Z
# GeoTrellis version suffix that determines the release type
GEOTRELLIS_VERSION_SUFFIX := ""
# path to PGP keys
Expand All @@ -59,7 +69,9 @@ CREDENTIALS_PATH := ~/.ivy2

## Building the container

First build the container using `make build`. The image will always be rebuilt from
First ensure that `RELEASE_TAG` in `Makefile` is set to the tag you wish to publish.

Then build the container using `make build`. The image will always be rebuilt from
scratch, cloning geotrellis and checking out the version branch.


Expand Down
File renamed without changes.