Skip to content

Commit

Permalink
Rename job -> workflow in .github + add interactive-release script to…
Browse files Browse the repository at this point in the history
… the shell (#6820)
  • Loading branch information
zeme-wana authored Feb 4, 2025
1 parent 8ec3367 commit 66aed87
Show file tree
Hide file tree
Showing 17 changed files with 39 additions and 34 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/broken-links.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# This job checks for broken links in various files in the repo.
# This workflow checks for broken links in various files in the repo.
#
# This job runs on all pull requests and on push to master, and it can also be triggered manually.
# This workflow runs on all pull requests and on push to master, and it can also be triggered manually.


name: "🔗 Broken Links"
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/cabal-build-all.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# This job runs `cabal build all` on Linux with all supported GHC versions.
# This workflow runs `cabal build all` on Linux with all supported GHC versions.
# Normally, if Nix can build the shell and the packages via haskell.nix, we can be confident that
# Cabal can build the project inside the Nix shell.
# However, this workflow is implemented to catch edge cases, such as the one described in
# https://github.com/IntersectMBO/plutus/issues/6625.
#
# This job runs on all pull requests and on push to master, and it can also be triggered manually.
# This workflow runs on all pull requests and on push to master, and it can also be triggered manually.


name: "👷 Cabal Build All"
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/cardano-constitution-tests.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# This job runs the nightly cardano-constitution tests.
# This workflow runs the nightly cardano-constitution tests.
#
# This job runs daily at 2am, and it can also be triggered manually.
# This workflow runs daily at 2am, and it can also be triggered manually.


name: "🗽 Cardano Constitution Tests"
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/changelog-label.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# This job enforces that: either some changelog.d/** files were added by the
# This workflow enforces that: either some changelog.d/** files were added by the
# PR, or the PR has the "No Changelog Required" label.
#
# This job runs on all pull requests, and on pull request label changes.
# This workflow runs on all pull requests, and on pull request label changes.


name: "🏷️ Changelog Label"
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/cost-model-benchmark.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# This job runs the cost model benchmark and uploads the results as a GitHub artifact.
# This workflow runs the cost model benchmark and uploads the results as a GitHub artifact.
#
# This job must be triggered manually via workflow dispatch.
# This workflow must be triggered manually via workflow dispatch.


name: "💰 Cost Model Benchmark"
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/docusaurus-site.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# This job builds and deploys the Docusaurus site.
# This workflow builds and deploys the Docusaurus site.
#
# This job builds the site on pull requests, and it also automatically deploys
# This workflow builds the site on pull requests, and it also automatically deploys
# the site on push to master or on workflow dispatch to:
# https://plutus.cardano.intersectmbo.org/docs

Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/haddock-site.yml
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# This job builds and deploys the Haddock site.
# This workflow builds and deploys the Haddock site.
#
# When this job is triggered manually via workflow dispatch, it builds and then
# When this workflow is triggered manually via workflow dispatch, it builds and then
# publishes the site according to the 'ref' input:
# https://plutus.cardano.intersectmbo.org/haddock/$ref
# And optionally (if the 'latest' flag is set) to:
# https://plutus.cardano.intersectmbo.org/haddock/latest
#
# This job also builds and publishes the site on push to master to:
# This workflow also builds and publishes the site on push to master to:
# https://plutus.cardano.intersectmbo.org/haddock/master
#
# This job does not trigger on each pull request because it takes about 1h to run.
# This workflow does not trigger on each pull request because it takes about 1h to run.
# However it will build (but not deploy) the site on pull requests to the release/* branches.


Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/longitudinal-benchmark.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# This job runs a suite of benchmarks and detects performance regressions.
# This workflow runs a suite of benchmarks and detects performance regressions.
# The benchmark charts are live at https://plutus.cardano.intersectmbo.org/dev/bench
# The benchmark data is available at https://plutus.cardano.intersectmbo.org/dev/bench/data.js
#
# This job runs on push to master, and on pull requests to the release/* branches,
# This workflow runs on push to master, and on pull requests to the release/* branches,
# and it can also be triggered manually.


Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/manual-benchmark.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# This job runs the desired benchmarks on demand.
# This workflow runs the desired benchmarks on demand.
#
# This job triggers whenever a comment is created in any PR.
# This workflow triggers whenever a comment is created in any PR.
# If the comment has this format: "/benchmark NAME"
# The this job will run the benchmark with the given NAME, first against
# The this workflow will run the benchmark with the given NAME, first against
# the current branch and then comparing the results against the master branch.


Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/metatheory-site.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
# On push to master, this workflows publishes to:
# https://plutus.cardano.intersectmbo.org/metatheory/master

# This job builds and deploys the Metatheory site.
# This workflow builds and deploys the Metatheory site.
#
# When this job is triggered manually via workflow dispatch, it builds and then
# When this workflow is triggered manually via workflow dispatch, it builds and then
# publishes the site according to the 'ref' input:
# https://plutus.cardano.intersectmbo.org/metatheory/$version
# And optionally (if the 'latest' flag is set) to:
# https://plutus.cardano.intersectmbo.org/metatheory/latest
#
# This job also builds and publishes the site on push to master to:
# This workflow also builds and publishes the site on push to master to:
# https://plutus.cardano.intersectmbo.org/metatheory/master


Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/nightly-testsuite.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# This job runs the nightly plutus-core-test and plutus-ir-test test suite.
# This workflow runs the plutus-core-test and plutus-ir-test test suite.
#
# This job runs daily at midnight, and it can also be triggered manually.
# This workflow runs daily at midnight, and it can also be triggered manually.


name: "🌘 Nightly Testsuite"
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/papers-and-specs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# This job builds and deploys various papers.
# This workflow builds and deploys various papers.
#
# This job runs on all push to master and can also be triggered manually.
# This workflow runs on all push to master and can also be triggered manually.
# It deploys the artifacts to: https://plutus.cardano.intersectmbo.org/resources

name: "📝 Papers & Specs"
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/plutus-tx-template.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# This job builds the plutus-tx-template using the current version of the plutus code.
# This workflow builds the plutus-tx-template using the current version of the plutus code.
#
# It ensures that the plutus-tx-template repository stays working even if there
# are changes in plutus. It checks out both the current commit of plutus and the
# master branch of plutus-tx-template. Then, it creates a cabal.project.local for
# plutus-tx-template that adjusts the plutus version. Finally, it double-checks
# that everything still builds correctly using cabal inside the devx shell.
#
# This job runs on all pull requests.
# This workflow runs on all pull requests.


name: "🏛️ PlutusTx Template"
Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/slack-message-broker.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# This job sends a message to the plutus-ci channel whenever a status check fails,
# This workflow sends a message to the plutus-ci channel whenever a status check fails,
# and tried to notify the author of the commit that caused the failure.
#
# This job triggers whenever a workflow run or a check run is completed.
# This workflow triggers whenever a workflow run or a check run is completed.

name: "📮 Slack Message Broker"

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/sprint-issues-rollover.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# This job moves issues and pull requests to the next sprint iteration of
# This workflow moves issues and pull requests to the next sprint iteration of
# the Plutus Backlog project. In practice, all open backlog items in the Current
# Iteration (the one that is still in progress) will be moved to the Next
# Iteration (the one that will start next).
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/triage-label.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Whenever a new issue is opened, this job adds the "status: needs triage"
# Whenever a new issue is opened, this workflow adds the "status: needs triage"
# label, unless the issue already has one of the INTERNAL_LABELS.

name: "🏷️ Triage Label"
Expand Down
5 changes: 5 additions & 0 deletions nix/shell.nix
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,11 @@ in {
${builtins.readFile certEnv}
'';

scripts.interactive-release = {
description = "Release a new version of Plutus";
exec = repoRoot.scripts."interactive-release.sh";
};

preCommit = {
stylish-haskell.enable = true;
cabal-fmt.enable = true;
Expand Down

0 comments on commit 66aed87

Please sign in to comment.