https://github.com/yetanalytics/action-deploy-clojars

GitHub Action to deploy Clojure libraries to Clojars.
https://github.com/yetanalytics/action-deploy-clojars

Last synced: 8 days ago
JSON representation

GitHub Action to deploy Clojure libraries to Clojars.

• Host: GitHub
• URL: https://github.com/yetanalytics/action-deploy-clojars
• Owner: yetanalytics
• License: apache-2.0
• Created: 2023-03-08T14:57:56.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-09-24T14:11:45.000Z (3 months ago)
• Last Synced: 2024-11-30T14:50:32.333Z (about 1 month ago)
• Language: Clojure
• Size: 32.2 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# action-deploy-clojars

GitHub Action to deploy Clojure libraries to Clojars.

When invoked, the action will compile a JAR file that will be deployed to Clojars. The JAR will also be stored as a workflow artifact. The following demonstrates a call to this action with all required inputs:

```yaml

    steps:

      - name: Setup environment # You will need to call this action first

        uses: yetanalytics/action-setup-env@

      - name: Deploy to clojars

        uses: yetanalytics/action-deploy-clojars@

        with:

          artifact-id: 'my-library'

          version: '0.1.0'

          clojars-username: ${{ secrets.CLOJARS_USERNAME }}

          clojars-deploy-token: ${{ secrets.CLOJARS_DEPLOY_TOKEN }}

```

The following is a table of all inputs:

Name | Description

--- | ---

`artifact-id`          | The Clojars Artifact ID (i.e. the name of the lib itself). **Required**

`version`              | The version string. (By Clojars convention, you should remove any prefixes, e.g. the `v` in `v0.1.0`.) **Required**

`clojars-username`     | The Clojars username (should be a GitHub secret). **Required**

`clojars-deploy-token` | The Clojars deploy token (should be a GitHub secret). **Required**

`group-id`             | The Clojars Group ID. Defaults to `'com.yetanalytics'`.

`license-name`         | The license that the project is distributed under. Defaults to `Apache-2.0`.

`license-url`          | A URL that links to the text of the license. Defaults to `https://www.apache.org/licenses/LICENSE-2.0.txt`.

`src-dirs`             | A quoted array of the source directories. Defaults to `'["src/main"]'`.

`resource-dirs`        | A quoted array of the resource directories. Defaults to `'["resources"]'`. Pass `'[]'` if no resource directories exist.

`publish`              | Whether or not to actually publish to Clojars. Default `true`; turn off for debugging.