Skip to content

Commit b4eae68

Browse files
committed
Create a distro for testing my GitHub Actions perl workflow
0 parents  commit b4eae68

File tree

20 files changed

+850
-0
lines changed

20 files changed

+850
-0
lines changed

.github/workflows/ci.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: Run tests
2+
3+
on:
4+
- pull_request
5+
- push
6+
7+
jobs:
8+
ci:
9+
uses: houseabsolute/workflow-perl-dzil-ci/.github/workflows/ci.yml@debug
10+
with:
11+
dist: Workflow-Testing
12+
ref: debug

.gitignore

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
/.build
2+
/.tidyall.d
3+
/test-mydeps-*
4+
*~
5+
.\#*
6+
Build
7+
Debian_CPANTS.txt
8+
MANIFEST
9+
META.json
10+
META.yml
11+
MYMETA.json
12+
MYMETA.yml
13+
Makefile
14+
Makefile.old
15+
README
16+
Workflow-Testing-*
17+
\#*\#
18+
_build
19+
blib*
20+
cover_db*
21+
pm_to_blib*

.mailmap

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Dave Rolsky <autarch@urth.org> <devnull@localhost>

CODE_OF_CONDUCT.md

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age,
8+
body size, disability, ethnicity, gender identity and expression, level of
9+
experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an
52+
appointed representative at an online or offline event. Representation of a
53+
project may be further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at autarch@urth.org. All complaints
59+
will be reviewed and investigated and will result in a response that is deemed
60+
necessary and appropriate to the circumstances. The project team is obligated
61+
to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
71+
version 1.4, available at
72+
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
73+
74+
[homepage]: https://www.contributor-covenant.org
75+

CONTRIBUTING.md

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
# CONTRIBUTING
2+
3+
Thank you for considering contributing to this distribution. This file
4+
contains instructions that will help you work with the source code.
5+
6+
Please note that if you have any questions or difficulties, you can reach the
7+
maintainer(s) through the bug queue described later in this document
8+
(preferred), or by emailing the releaser directly. You are not required to
9+
follow any of the steps in this document to submit a patch or bug report;
10+
these are just recommendations, intended to help you (and help us help you
11+
faster).
12+
13+
The distribution is managed with
14+
[Dist::Zilla](https://metacpan.org/release/Dist-Zilla).
15+
16+
However, you can still compile and test the code with the
17+
`Makefile.PL`
18+
in the repository:
19+
20+
perl Makefile.PL
21+
make
22+
make test
23+
24+
25+
You may need to satisfy some dependencies. The easiest way to satisfy
26+
dependencies is to install the last release. This is available at
27+
https://metacpan.org/release/Workflow-Testing
28+
29+
You can use [`cpanminus`](https://metacpan.org/pod/App::cpanminus) to do this
30+
without downloading the tarball first:
31+
32+
$> cpanm --reinstall --installdeps --with-recommends Workflow::Testing
33+
34+
[`Dist::Zilla`](https://metacpan.org/pod/Dist::Zilla) is a very powerful
35+
authoring tool, but requires a number of author-specific plugins. If you would
36+
like to use it for contributing, install it from CPAN, then the following
37+
command to install the needed distros:
38+
39+
$> dzil authordeps --missing | cpanm
40+
41+
There may also be additional requirements not needed by the dzil build which
42+
are needed for tests or other development:
43+
44+
$> dzil listdeps --author --missing | cpanm
45+
46+
Or, you can use the 'dzil stale' command to install all requirements at once:
47+
48+
$> cpanm Dist::Zilla::App::Command::stale
49+
$> dzil stale --all | cpanm
50+
51+
You can also do this via cpanm directly:
52+
53+
$> cpanm --reinstall --installdeps --with-develop --with-recommends Workflow::Testing
54+
55+
Once installed, here are some dzil commands you might try:
56+
57+
$> dzil build
58+
$> dzil test
59+
$> dzil test --release
60+
$> dzil xtest
61+
$> dzil listdeps --json
62+
$> dzil build --notgz
63+
64+
You can learn more about Dist::Zilla at http://dzil.org/.
65+
66+
The code for this distribution is [hosted on GitHub](https://github.com/houseabsolute/workflow-perl-dzil-ci-testing).
67+
68+
You can submit code changes by forking the repository, pushing your code
69+
changes to your clone, and then submitting a pull request. Please update the
70+
Changes file with a user-facing description of your changes as part of your
71+
work. See the GitHub documentation for [detailed instructions on pull
72+
requests](https://help.github.com/articles/creating-a-pull-request)
73+
74+
If you have found a bug, but do not have an accompanying patch to fix it, you
75+
can submit an issue report [via the web](https://github.com/houseabsolute/workflow-perl-dzil-ci-testing/issues).
76+
77+
78+
## Precious
79+
80+
This distribution uses [precious](https://github.com/houseabsolute/precious)
81+
to enforce a uniform coding style. This is tested as part of the author
82+
testing suite. You can install this and any other necessary non-Perl tools by
83+
running `./dev-bin/install-xt-tools.sh`.
84+
85+
Then you can use `precious` to tidy and lint your code:
86+
87+
$> precious tidy -a
88+
$> precious lint -a
89+
90+
Please run `precious tidy -a` and `precious lint -a` before committing your
91+
changes and address any issues that it reports.
92+
93+
You can also set up a git pre-commit hook that checks all changed files for
94+
linting issues by running `./git/setup.pl`.
95+
96+
## Contributor Names
97+
98+
If you send a patch or pull request, your name and email address will be
99+
included in the documentation as a contributor (using the attribution on the
100+
commit or patch), unless you specifically request for it not to be. If you
101+
wish to be listed under a different name or address, you should submit a pull
102+
request to the `.mailmap` file to contain the correct mapping.
103+
104+
## Generated By
105+
106+
This file was generated via Dist::Zilla::Plugin::GenerateFile::FromShareDir 0.015 from a
107+
template file originating in Dist-Zilla-PluginBundle-DROLSKY-1.22.

Changes

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{{$NEXT}}
2+
3+
- First release upon an unsuspecting world.

0 commit comments

Comments
 (0)