Skip to content

Commit

Permalink
Initial set of files.
Browse files Browse the repository at this point in the history
  • Loading branch information
drupol committed Nov 30, 2021
1 parent 825e71b commit d2958a9
Show file tree
Hide file tree
Showing 21 changed files with 427 additions and 0 deletions.
9 changes: 9 additions & 0 deletions .auto-changelog
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"output": "CHANGELOG.md",
"template": "keepachangelog",
"unreleased": true,
"commitLimit": false,
"hideCredit": true,
"sortCommits": "date-desc",
"breakingPattern": "BREAKING CHANGE: yes"
}
18 changes: 18 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# This file is for unifying the coding style for different editors and IDEs
# editorconfig.org

# PHP PSR-2 Coding Standards
# http://www.php-fig.org/psr/psr-2/

root = true

[*.{php,inc,module}]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
indent_style = space
indent_size = 4

[*.{json,json.dist,yml,yml.dist}]
indent_size = 4
1 change: 1 addition & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* @loophp
46 changes: 46 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at pol.dellaiera@protonmail.com. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
3 changes: 3 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# CONTRIBUTING

TODO
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
github: drupol
13 changes: 13 additions & 0 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
## Steps required to reproduce the problem

1.
2.
3.

## Expected Result

*

## Actual Result

*
9 changes: 9 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
This PR

* [x]
* [ ]
* [ ]

Follows #.
Related to #.
Fixes #.
7 changes: 7 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
version: 2
updates:
- package-ecosystem: github-actions
directory: "/"
schedule:
interval: daily
open-pull-requests-limit: 10
47 changes: 47 additions & 0 deletions .github/settings.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# https://github.com/probot/settings

branches:
- name: main
protection:
enforce_admins: false
required_pull_request_reviews:
dismiss_stale_reviews: true
require_code_owner_reviews: true
required_approving_review_count: 1
restrictions: null
required_linear_history: true

labels:
- name: bug
color: ee0701

- name: dependencies
color: 0366d6

- name: enhancement
color: 0e8a16

- name: question
color: cc317c

- name: security
color: ee0701

- name: stale
color: eeeeee

repository:
allow_merge_commit: true
allow_rebase_merge: true
allow_squash_merge: true
default_branch: main
description: "Provide a 'ready-to-use' Github workflow to update 'flake.lock' file automatically."
homepage:
topics: nix, flake, workflow
has_downloads: false
has_issues: true
has_pages: false
has_projects: false
has_wiki: false
name: flake-lock-update-workflow
private: false
10 changes: 10 additions & 0 deletions .github/stale.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
daysUntilStale: 60

daysUntilClose: 7

staleLabel: stale

markComment: >
This issue has been automatically marked as stale because it has not had
recent activity. It will be closed if no further activity occurs. Thank you
for your contributions.
44 changes: 44 additions & 0 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# https://docs.github.com/en/actions

name: "Release"

on: # yamllint disable-line rule:truthy
push:
tags:
- "**"

jobs:
release:
name: "Tag"

runs-on: "ubuntu-latest"

steps:
- name: Checkout
uses: actions/checkout@v2.4.0
with:
fetch-depth: 1

- name: Determine tag
id: tag_name
run: |
echo ::set-output name=current_version::${GITHUB_REF#refs/tags/}
shell: bash

- name: Get Changelog Entry
id: changelog_reader
uses: mindsers/changelog-reader-action@v2
with:
version: ${{ steps.tag_name.outputs.current_version }}
path: ./CHANGELOG.md

- name: "Create release"
uses: "actions/create-release@v1.1.4"
env:
GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
with:
release_name: "${{ steps.tag_name.outputs.current_version }}"
tag_name: "${{ steps.tag_name.outputs.current_version }}"
body: ${{ steps.changelog_reader.outputs.changes }}
prerelease: ${{ steps.changelog_reader.outputs.status == 'prereleased' }}
draft: ${{ steps.changelog_reader.outputs.status == 'unreleased' }}
11 changes: 11 additions & 0 deletions .github/workflows/test-upgrade-flakes.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
name: "Test flake lock file update workflow"

on:
push:
pull_request:
schedule:
- cron: "0 6 * * *"

jobs:
createPullRequest:
uses: loophp/flake-lock-update-workflow/.github/workflows/upgrade-flakes.yaml@1.0.0
22 changes: 22 additions & 0 deletions .github/workflows/upgrade-flakes.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
name: 'Update flake lock file'

on:
workflow_call: ~

jobs:
updateFlakeLock:
runs-on: ubuntu-20.04

steps:
- name: Checkout
uses: actions/checkout@v2.4.0
with:
fetch-depth: 1

- name: Install Nix
uses: cachix/install-nix-action@v16
with:
nix_path: nixpkgs=channel:nixos-unstable

- name: Update flake.lock
uses: DeterminateSystems/update-flake-lock@v4
12 changes: 12 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
/composer.lock
/vendor
/build
/docs/_build
/.php_cs.cache
/.php-cs-fixer.cache
/examples/
/.idea/
/test.php
/node_modules/
/benchmarks/
/.vscode/
20 changes: 20 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
The MIT License (MIT)

Copyright (c) 2019-2021 Pol Dellaiera

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
74 changes: 74 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
[![GitHub stars][github stars]][1]
[![Donate!][donate github]][5]
[![Donate!][donate paypal]][6]

# Flake Lock Update Workflow

## Description

This repository provide a Github Workflow file ready to use to make sure that the `flake.lock`
file in your repository stay up-to-date by creating a pull-request every time it detected
some changes.

Read more information about this feature [on Github][50].

## Usage

Create an action file in `.github/workflows/` with:

```yaml
name: 'Update flake lock file'

on:
schedule:
- cron: '0 6 * * *'

jobs:
createPullRequest:
uses: loophp/flake-lock-update-workflow/.github/workflows/upgrade-flakes.yaml@1.0.0
```
And it's done!
## Contributing
Feel free to contribute by sending Github pull requests. I'm quite responsive :-)
If you can't contribute to the code, you can also sponsor me on [Github][5] or
[Paypal][6].
## Changelog
See [CHANGELOG.md][43] for a changelog based on [git commits][44].
For more detailed changelogs, please check [the release changelogs][45].
[1]: https://packagist.org/packages/loophp/flake-lock-update-workflow
[latest stable version]: https://img.shields.io/packagist/v/loophp/flake-lock-update-workflow.svg?style=flat-square
[github stars]: https://img.shields.io/github/stars/loophp/flake-lock-update-workflow.svg?style=flat-square
[total downloads]: https://img.shields.io/packagist/dt/loophp/flake-lock-update-workflow.svg?style=flat-square
[github workflow status]: https://img.shields.io/github/workflow/status/loophp/flake-lock-update-workflow/Unit%20tests?style=flat-square
[code quality]: https://img.shields.io/scrutinizer/quality/g/loophp/flake-lock-update-workflow/master.svg?style=flat-square
[3]: https://scrutinizer-ci.com/g/loophp/flake-lock-update-workflow/?branch=master
[type coverage]: https://img.shields.io/badge/dynamic/json?style=flat-square&color=color&label=Type%20coverage&query=message&url=https%3A%2F%2Fshepherd.dev%2Fgithub%2Floophp%2Fcollection%2Fcoverage
[4]: https://shepherd.dev/github/loophp/flake-lock-update-workflow
[code coverage]: https://img.shields.io/scrutinizer/coverage/g/loophp/flake-lock-update-workflow/master.svg?style=flat-square
[license]: https://img.shields.io/packagist/l/loophp/flake-lock-update-workflow.svg?style=flat-square
[donate github]: https://img.shields.io/badge/Sponsor-Github-brightgreen.svg?style=flat-square
[donate paypal]: https://img.shields.io/badge/Sponsor-Paypal-brightgreen.svg?style=flat-square
[34]: https://github.com/loophp/flake-lock-update-workflow/issues
[2]: https://github.com/loophp/flake-lock-update-workflow/actions
[35]: http://www.phpspec.net/
[36]: https://github.com/phpro/grumphp
[37]: https://github.com/infection/infection
[38]: https://github.com/phpstan/phpstan
[39]: https://github.com/vimeo/psalm
[5]: https://github.com/sponsors/loophp
[6]: https://www.paypal.me/loophp
[43]: https://github.com/loophp/flake-lock-update-workflow/blob/master/CHANGELOG.md
[44]: https://github.com/loophp/flake-lock-update-workflow/commits/master
[45]: https://github.com/loophp/flake-lock-update-workflow/releases
[46]: https://nixos.org/guides/nix-pills/developing-with-nix-shell.html
[47]: https://github.com/jtojnar
[48]: https://github.com/fossar/nix-phps
[50]: https://docs.github.com/en/actions/learn-github-actions/reusing-workflows
8 changes: 8 additions & 0 deletions docker-compose.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
version: "3"

services:
auto_changelog:
build: docker/auto-changelog
working_dir: /src
volumes:
- .:/src
13 changes: 13 additions & 0 deletions docker/auto-changelog/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
FROM node:15.4.0-alpine

ENV SRC_PATH /src

RUN apk add --no-cache git
RUN npm install -g auto-changelog@2.2.1
RUN mkdir -p $SRC_PATH

VOLUME [ "$SRC_PATH" ]
WORKDIR $SRC_PATH

CMD ["--help"]
ENTRYPOINT ["auto-changelog"]
Loading

0 comments on commit d2958a9

Please sign in to comment.