generated from cfillion/reapack-repository-template
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
0 parents
commit af8e45a
Showing
6 changed files
with
141 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
name: check | ||
on: [push, pull_request] | ||
jobs: | ||
reapack-index: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Fetch repository | ||
uses: actions/checkout@v2 | ||
- name: Install Pandoc | ||
run: sudo apt-get install -yy pandoc | ||
- name: Set up Ruby | ||
uses: ruby/setup-ruby@v1 | ||
with: | ||
ruby-version: '3.0' | ||
- name: Install reapack-index | ||
run: gem install reapack-index | ||
- name: Validate packages | ||
run: reapack-index --check |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
name: deploy | ||
on: | ||
push: | ||
branches: [master] | ||
jobs: | ||
reapack-index: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Fetch repository | ||
uses: actions/checkout@v2 | ||
with: | ||
fetch-depth: 0 | ||
- name: Configure git | ||
run: |- | ||
git config user.name 'ReaTeam Bot' | ||
git config user.email 'reateam-bot@cfillion.ca' | ||
- name: Install Pandoc | ||
run: sudo apt-get install -yy pandoc | ||
- name: Set up Ruby | ||
uses: ruby/setup-ruby@v1 | ||
with: | ||
ruby-version: '3.0' | ||
- name: Install reapack-index | ||
run: gem install reapack-index | ||
- name: Update index.xml | ||
run: reapack-index --commit | ||
- name: Push changes | ||
run: git push |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
--about README.md | ||
--commit-template "index: $changelog | ||
|
||
[ci skip]" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
-- @description Hello world | ||
-- @author cfillion | ||
-- @version 1.0 | ||
-- @about | ||
-- This is an example of a package file. It installs itself as a ReaScript that | ||
-- does nothing but show "Hello World!" in REAPER's scripting console. | ||
-- | ||
-- Packages may also include additional files specified using the @provides tag. | ||
-- | ||
-- This text is the documentation shown when using ReaPack's "About this package" | ||
-- feature. [Markdown](https://commonmark.org/) *formatting* is supported. | ||
|
||
reaper.ShowConsoleMsg 'Hello World!' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# ReaPack Repository Template | ||
|
||
A template for GitHub-hosted ReaPack repositories with automated | ||
[reapack-index](https://github.com/cfillion/reapack-index) | ||
running from GitHub Actions. | ||
|
||
Replace the name of the repository in [index.xml](/index.xml) when using this template. | ||
This will be the name shown in ReaPack. | ||
|
||
```xml | ||
<index version="1" name="Name of your repository here"> | ||
``` | ||
|
||
Replace the contents of this file ([README.md](/README.md)). | ||
This will be the text shown when using ReaPack's "About this repository" feature. | ||
|
||
reapack-index looks for package files in subfolders. | ||
The folder tree represents the package categories shown in ReaPack. | ||
|
||
Each package file is expected to begin with a metadata header. | ||
See [Packaging Documentation](https://github.com/cfillion/reapack-index/wiki/Packaging-Documentation) on reapack-index's wiki. | ||
|
||
The URL to import in ReaPack is [https://github.com/`<your username>`/`<repository name>`/raw/master/index.xml](https://github.com/cfillion/reapack-repository-template/raw/master/index.xml). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
<?xml version="1.0" encoding="utf-8"?> | ||
<index version="1" name="ReaPack Repository Template" commit="58a3e39ba95bd0f35846aa1f39aa4cb2574295e1"> | ||
<category name="Example"> | ||
<reapack name="cfillion_Hello world.lua" type="script" desc="Hello world"> | ||
<metadata> | ||
<description><![CDATA[{\rtf1\ansi\deff0{\fonttbl{\f0 \fswiss Helvetica;}{\f1 Courier;}} | ||
{\colortbl;\red255\green0\blue0;\red0\green0\blue255;} | ||
\widowctrl\hyphauto | ||
{\pard \ql \f0 \sa180 \li0 \fi0 This is an example of a package file. It installs itself as a ReaScript that does nothing but show "Hello World!" in REAPER's scripting console.\par} | ||
{\pard \ql \f0 \sa180 \li0 \fi0 Packages may also include additional files specified using the @provides tag.\par} | ||
{\pard \ql \f0 \sa180 \li0 \fi0 This text is the documentation shown when using ReaPack's "About this package" feature. {\field{\*\fldinst{HYPERLINK "https://commonmark.org/"}}{\fldrslt{\ul | ||
Markdown | ||
}}} | ||
{\i formatting} is supported.\par} | ||
} | ||
]]></description> | ||
</metadata> | ||
<version name="1.0" author="cfillion" time="2021-01-04T23:30:32Z"> | ||
<source main="main">https://github.com/cfillion/reapack-repository-template/raw/58a3e39ba95bd0f35846aa1f39aa4cb2574295e1/Example/cfillion_Hello%20world.lua</source> | ||
</version> | ||
</reapack> | ||
</category> | ||
<metadata> | ||
<description><![CDATA[{\rtf1\ansi\deff0{\fonttbl{\f0 \fswiss Helvetica;}{\f1 Courier;}} | ||
{\colortbl;\red255\green0\blue0;\red0\green0\blue255;} | ||
\widowctrl\hyphauto | ||
{\pard \ql \f0 \sa180 \li0 \fi0 \b \fs36 ReaPack Repository Template\par} | ||
{\pard \ql \f0 \sa180 \li0 \fi0 A template for GitHub-hosted ReaPack repositories with automated {\field{\*\fldinst{HYPERLINK "https://github.com/cfillion/reapack-index"}}{\fldrslt{\ul | ||
reapack-index | ||
}}} | ||
running from GitHub Actions.\par} | ||
{\pard \ql \f0 \sa180 \li0 \fi0 Replace the name of the repository in {\field{\*\fldinst{HYPERLINK "/index.xml"}}{\fldrslt{\ul | ||
index.xml | ||
}}} | ||
when using this template. This will be the name shown in ReaPack.\par} | ||
{\pard \ql \f0 \sa180 \li0 \fi0 \f1 <index version="1" name="Name of your repository here">\par} | ||
{\pard \ql \f0 \sa180 \li0 \fi0 Replace the contents of this file ({\field{\*\fldinst{HYPERLINK "/README.md"}}{\fldrslt{\ul | ||
README.md | ||
}}} | ||
). This will be the text shown when using ReaPack's "About this repository" feature.\par} | ||
{\pard \ql \f0 \sa180 \li0 \fi0 reapack-index looks for package files in subfolders. The folder tree represents the package categories shown in ReaPack.\par} | ||
{\pard \ql \f0 \sa180 \li0 \fi0 Each package file is expected to begin with a metadata header. See {\field{\*\fldinst{HYPERLINK "https://github.com/cfillion/reapack-index/wiki/Packaging-Documentation"}}{\fldrslt{\ul | ||
Packaging Documentation | ||
}}} | ||
on reapack-index's wiki.\par} | ||
{\pard \ql \f0 \sa180 \li0 \fi0 The URL to import in ReaPack is {\field{\*\fldinst{HYPERLINK "https://github.com/cfillion/reapack-repository-template/raw/master/index.xml"}}{\fldrslt{\ul | ||
https://github.com/{\f1 <your username>}/{\f1 <repository name>}/raw/master/index.xml | ||
}}} | ||
.\par} | ||
} | ||
]]></description> | ||
</metadata> | ||
</index> |