Skip to content

Commit

Permalink
Merge pull request #111 from arillso/1.1.0-small-revision
Browse files Browse the repository at this point in the history
small revision
  • Loading branch information
sbaerlocher authored Feb 11, 2022
2 parents debaffe + 0ac8adc commit 9cb69ac
Show file tree
Hide file tree
Showing 21 changed files with 4,468 additions and 10,571 deletions.
68 changes: 0 additions & 68 deletions .eslintrc.json

This file was deleted.

27 changes: 27 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
version: 2
updates:
- package-ecosystem: npm
directory: "/"
schedule:
interval: monthly
reviewers:
- sbaerlocher
assignees:
- sbaerlocher
commit-message:
prefix: fix
prefix-development: chore
include: scope

- package-ecosystem: github-actions
directory: "/"
schedule:
interval: monthly
reviewers:
- sbaerlocher
assignees:
- sbaerlocher
commit-message:
prefix: fix
prefix-development: chore
include: scope
1 change: 1 addition & 0 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,3 +16,4 @@ jobs:
uses: ./
with:
api_key: ${{ secrets.GALAXY_API_KEY }}
collection_dir: tests/collection
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ and [human-readable changelog](https://keepachangelog.com/en/1.0.0/).

## master

## 1.2.0

### Changed

- NPM dependency updates

## 1.0.3

### Changed
Expand Down
4 changes: 3 additions & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
Copyright (c) 2020 Arillso
MIT License

Copyright (c) 2022 Arillso

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,25 @@ Build and publish an Ansible Collection to Ansible Galaxy.

### api_key

**Required** Ansible Galaxy API key.
## api_key

**Required**: Ansible Galaxy API key.

This should be stored in a Secret on GitHub. See [Creating and Using Secrets Encrypted Variables](https://help.github.com/en/github/automating-your-workflow-with-github-actions/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables).

### galaxy_config_file
## collection_dir

**Default**: `./`

The directory in which the Ansible Collection is stored. This defaults to the project root.

Only change this if your Collection is not stored in your project root.

## galaxy_version

**Default**: `galaxy.yml`
Semver-compatible string: `1`, `1.1`, `1.1.1`, `1.1.1-alpha`

A collection must have a galaxy.yml file that contains the necessary information to build a collection artifact. Defaults to `galaxy.yml` in the project root.
Dynamically inject a semver-compatible version into your `galaxy.yml` file.

## Example Usage

Expand Down
35 changes: 26 additions & 9 deletions action.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: 'Publish Ansible Collection'
description: 'Build and publish an Ansible Collection to Ansible Galaxy'
name: "Publish Ansible Collection"
description: "Build and publish an Ansible Collection to Ansible Galaxy"
author: 'Simon Baerlocher <[email protected]>"'
inputs:
api_key:
Expand All @@ -9,12 +9,29 @@ inputs:
See https://help.github.com/en/github/automating-your-workflow-with-github-actions/virtual-environments-for-github-actions#creating-and-using-secrets-encrypted-variables.
required: true
galaxy_config_file:
description: 'A collection must have a galaxy.yml file that contains the necessary information to build a collection artifact. Defaults to "galaxy.yml" in the project root.'
default: 'galaxy.yml'
collection_dir:
description: |
The directory in which the Ansible Collection is stored. This defaults to the project root.
required: false
default: "./"
build:
description: |
You can now choose to build a collection without publishing, and vice versa.
If you wish to disable building a collection, set this parameter to "false."
required: true
default: "true"
publish:
description: |
You can now choose to publish a collection without building (from a pre-built archive), and vice versa.
If you wish to disable publishing a collection, set this parameter to "false."
required: true
default: "true"
galaxy_version:
description: Dynamically inject a semver-compatible version into your galaxy.yml file.
required: false
runs:
using: 'node12'
main: 'dist/index.js'
using: "node12"
main: "dist/index.js"
branding:
icon: 'box'
color: 'black'
icon: "box"
color: "black"
Loading

0 comments on commit 9cb69ac

Please sign in to comment.