Skip to content

Commit

Permalink
updated example & Input Args in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
2bndy5 committed Jul 5, 2020
1 parent bb25dcb commit 9f4b5f6
Showing 1 changed file with 40 additions and 14 deletions.
54 changes: 40 additions & 14 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,10 @@ rmskin-action

A Python-based Github action tool to package a Repository's Rainmeter Content into a validating .rmskin file for Rainmeter's Skin Installer

.. Input Arguments
.. ===============
Input Arguments
===============

.. * ``version`` : (Optional) Version of the Rainmeter rmskin package.
.. * ``title`` : (Optional) Name of the Rainmeter rmskin package.
.. * ``author`` : (Optional) Account Username maintaining the rmskin package.
.. * ``path`` : (Optional) Base directory of repo being packaged.
Please use your repository's ``RMSKIN.ini`` file to override any default inputs

Output Arguments
================
Expand All @@ -26,23 +23,52 @@ Example Usage

.. code-block:: yaml
jobs:
Build:
name: RMSKIN Packager
on:
push:
pull_request:
release:
types:
- published
# - edited
jobs:
Build_n_Release:
runs-on: ubuntu-latest
steps:
# Checkout code
- name: Checkout this Repo
uses: actions/checkout@v2
# # print contents of GITHUB_WORKSPACE dir
# - name: verify contents
# run: ls $GITHUB_WORKSPACE
# Runs a this repo's action
# Runs a rmskin packager action
- name: Run Build action
id: builder
uses: 2bndy5/rmskin-action@master
# Use the output from the `builder` step
- name: Print the output path & filename
- name: Print the output filename
run: echo "The output file was ${{ steps.builder.outputs.arc_name }}"
# get release upload_url
- name: Get Release
id: get_release
uses: bruceadams/[email protected]
if: github.event_name == 'release'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# Upload the asset
- name: Upload Release Asset
id: upload-release-asset
uses: actions/upload-release-asset@v1
if: github.event_name == 'release'
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
upload_url: ${{ steps.create_release.outputs.upload_url || steps.get_release.outputs.upload_url }}
asset_path: ./${{ steps.builder.outputs.arc_name }}
asset_name: ${{ steps.builder.outputs.arc_name }}
asset_content_type: application/zip

0 comments on commit 9f4b5f6

Please sign in to comment.