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.

Sign up for GitHub

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

Keep publish secrets scoped to specific steps #92

Merged
merged 6 commits into from
Jan 23, 2022
Merged

Keep publish secrets scoped to specific steps #92

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
f3f3fdc
Keep publish secrets scoped to publish job
armanbilge Jan 23, 2022
6c5fcdd
Merge branch 'main' into topic/scoped-secrets
armanbilge Jan 23, 2022
2373e70
Revert "Keep publish secrets scoped to publish job"
armanbilge Jan 23, 2022
1ba78de
Keep secrets scoped to steps
armanbilge Jan 23, 2022
f867dce
Try an experiment
armanbilge Jan 23, 2022
520f571
I guess it works
armanbilge Jan 23, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,6 @@ on:
tags: [v*]

env:
PGP_PASSPHRASE: ${{ secrets.PGP_PASSPHRASE }}
SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}
SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }}
PGP_SECRET: ${{ secrets.PGP_SECRET }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

jobs:
Expand Down Expand Up @@ -132,17 +128,26 @@ jobs:
rm targets.tar

- name: Import signing key
if: env.PGP_SECRET != '' && env.PGP_PASSPHRASE == ''
if: secrets.PGP_SECRET != '' && secrets.PGP_PASSPHRASE == ''
Copy link
Member Author

Choose a reason for hiding this comment

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

Secrets can't be used in conditionals. I'm not sure if we can use env here if we only set it for this step (not sure what happens first).

env:
PGP_SECRET: ${{ secrets.PGP_SECRET }}
PGP_PASSPHRASE: ${{ secrets.PGP_PASSPHRASE }}
run: echo $PGP_SECRET | base64 -d | gpg --import

- name: Import signing key and strip passphrase
if: env.PGP_SECRET != '' && env.PGP_PASSPHRASE != ''
if: secrets.PGP_SECRET != '' && secrets.PGP_PASSPHRASE != ''
env:
PGP_SECRET: ${{ secrets.PGP_SECRET }}
PGP_PASSPHRASE: ${{ secrets.PGP_PASSPHRASE }}
run: |
echo "$PGP_SECRET" | base64 -d > /tmp/signing-key.gpg
echo "$PGP_PASSPHRASE" | gpg --pinentry-mode loopback --passphrase-fd 0 --import /tmp/signing-key.gpg
(echo "$PGP_PASSPHRASE"; echo; echo) | gpg --command-fd 0 --pinentry-mode loopback --change-passphrase $(gpg --list-secret-keys --with-colons 2> /dev/null | grep '^sec:' | cut --delimiter ':' --fields 5 | tail -n 1)

- name: Publish
env:
SONATYPE_USERNAME: ${{ secrets.SONATYPE_USERNAME }}
SONATYPE_PASSWORD: ${{ secrets.SONATYPE_PASSWORD }}
run: sbt '++${{ matrix.scala }}' tlRelease

site:
Expand Down
15 changes: 9 additions & 6 deletions ci-signing/src/main/scala/org/typelevel/sbt/TypelevelCiSigningPlugin.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,15 +29,12 @@ object TypelevelCiSigningPlugin extends AutoPlugin {
override def trigger = allRequirements

override def buildSettings = Seq(
githubWorkflowEnv ++= Map(
"PGP_SECRET" -> s"$${{ secrets.PGP_SECRET }}",
"PGP_PASSPHRASE" -> s"$${{ secrets.PGP_PASSPHRASE }}"
),
githubWorkflowPublishPreamble := Seq(
WorkflowStep.Run( // if your key is not passphrase-protected
List("echo $PGP_SECRET | base64 -d | gpg --import"),
name = Some("Import signing key"),
cond = Some("env.PGP_SECRET != '' && env.PGP_PASSPHRASE == ''")
cond = Some("secrets.PGP_SECRET != '' && secrets.PGP_PASSPHRASE == ''"),
env = env
),
WorkflowStep.Run( // if your key is passphrase-protected
List(
Expand All @@ -46,7 +43,8 @@ object TypelevelCiSigningPlugin extends AutoPlugin {
"(echo \"$PGP_PASSPHRASE\"; echo; echo) | gpg --command-fd 0 --pinentry-mode loopback --change-passphrase $(gpg --list-secret-keys --with-colons 2> /dev/null | grep '^sec:' | cut --delimiter ':' --fields 5 | tail -n 1)"
),
name = Some("Import signing key and strip passphrase"),
cond = Some("env.PGP_SECRET != '' && env.PGP_PASSPHRASE != ''")
cond = Some("secrets.PGP_SECRET != '' && secrets.PGP_PASSPHRASE != ''"),
env = env
)
)
)
Expand All @@ -57,4 +55,9 @@ object TypelevelCiSigningPlugin extends AutoPlugin {
gpgWarnOnFailure := isSnapshot.value
)

private val env = Map(
"PGP_SECRET" -> s"$${{ secrets.PGP_SECRET }}",
"PGP_PASSPHRASE" -> s"$${{ secrets.PGP_PASSPHRASE }}"
)

}
11 changes: 6 additions & 5 deletions sonatype-ci-release/src/main/scala/org/typelevel/sbt/TypelevelSonatypeCiReleasePlugin.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,6 @@ object TypelevelSonatypeCiReleasePlugin extends AutoPlugin {
Seq(tlCiReleaseTags := true, tlCiReleaseBranches := Seq())

override def buildSettings = Seq(
githubWorkflowEnv ++= Map(
"SONATYPE_USERNAME" -> s"$${{ secrets.SONATYPE_USERNAME }}",
"SONATYPE_PASSWORD" -> s"$${{ secrets.SONATYPE_PASSWORD }}"
),
githubWorkflowPublishTargetBranches := {
val branches =
tlCiReleaseBranches.value.map(b => RefPredicate.Equals(Ref.Branch(b)))
Expand All @@ -59,7 +55,12 @@ object TypelevelSonatypeCiReleasePlugin extends AutoPlugin {
},
githubWorkflowTargetTags += "v*",
githubWorkflowPublish := Seq(
WorkflowStep.Sbt(List("tlRelease"), name = Some("Publish"))
WorkflowStep.Sbt(List("tlRelease"), name = Some("Publish"), env = env)
)
)

private val env = Map(
"SONATYPE_USERNAME" -> s"$${{ secrets.SONATYPE_USERNAME }}",
"SONATYPE_PASSWORD" -> s"$${{ secrets.SONATYPE_PASSWORD }}"
)
}