From 75a1d867ccb08a2ae4d0c299d034c266c8f1fc57 Mon Sep 17 00:00:00 2001 From: kdeldycke <159718+kdeldycke@users.noreply.github.com> Date: Fri, 1 Mar 2024 14:07:32 +0000 Subject: [PATCH] [sync] Update template URLs --- .github/ISSUE_TEMPLATE/new-link.yaml | 52 ------------ .github/code-of-conduct.md | 74 ----------------- .github/contributing.md | 115 -------------------------- .github/dependabot.yaml | 14 ---- .github/pull_request_template.md | 25 ------ .github/workflows/autofix.yaml | 13 --- .github/workflows/autolock.yaml | 11 --- .github/workflows/docs.yaml | 74 +---------------- .github/workflows/label-sponsors.yaml | 14 ---- .github/workflows/labels.yaml | 11 --- .github/workflows/lint.yaml | 9 -- 11 files changed, 1 insertion(+), 411 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/new-link.yaml b/.github/ISSUE_TEMPLATE/new-link.yaml index 96d6e1c..e69de29 100644 --- a/.github/ISSUE_TEMPLATE/new-link.yaml +++ b/.github/ISSUE_TEMPLATE/new-link.yaml @@ -1,52 +0,0 @@ -name: Add new link -description: You would like to add a new link to the collection -labels: ["🆕 new link"] -body: - - - type: input - id: link - attributes: - label: URL of the article or project - validations: - required: true - - - type: textarea - id: motivation - attributes: - label: Motivation - description: > - Explain the motivation for adding this link to the current collection. What's special about it? - placeholder: | - This new link is special because... - validations: - required: true - - - type: checkboxes - id: affiliation - attributes: - label: Affiliation - description: > - Please indicate how you are associated with the new proposed content. - options: - - label: "I am the author of the article or project" - - label: "I am working for/with the company which is publishing the article or project" - - label: "I'm just a rando who stumbled upon this via social networks" - validations: - required: true - - - type: checkboxes - id: self-checks - attributes: - label: Self checks - options: - - label: > - I have [read the Code of - Conduct](https://github.com/kdeldycke/awesome-billing/blob/main/.github/code-of-conduct.md) - - label: > - I applied all rules from the [Contributing - guide](https://github.com/kdeldycke/awesome-billing/blob/main/.github/contributing.md) - - label: > - I have checked there is no other [Issues](https://github.com/kdeldycke/awesome-billing/issues) or [Pull - Requests](https://github.com/kdeldycke/awesome-billing/pulls) covering the same topic to open - validations: - required: true \ No newline at end of file diff --git a/.github/code-of-conduct.md b/.github/code-of-conduct.md index 18a2b22..e69de29 100644 --- a/.github/code-of-conduct.md +++ b/.github/code-of-conduct.md @@ -1,74 +0,0 @@ -# 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 . All -complaints will be reviewed and investigated and will result in a response that -is deemed necessary and 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 [https://contributor-covenant.org/version/1/4][version] - -[homepage]: https://contributor-covenant.org -[version]: https://contributor-covenant.org/version/1/4/ diff --git a/.github/contributing.md b/.github/contributing.md index b5574ac..e69de29 100644 --- a/.github/contributing.md +++ b/.github/contributing.md @@ -1,115 +0,0 @@ -# Contributing - -Your contributions are always welcome! Here are some guidelines. - -## Status - -This repository has reached an equilibrium state. We are past its accumulation phase, and in the middle of the curation process. Meaning we're more into refining its concepts, smooth the progression and carefully evaluating the addition of new content. - -## Pull-requests and issues - -- Search past and current issues and pull-requests for previous suggestions before making a new one. Yours may be a duplicate or a work in progress. - -- Only one list item per commit. - -- Only one commit per pull-request. Always squash commits after applying changes. - -- Check your spelling and grammar. - -- Add the reason why the linked resource is awesome. And what it adds to the existing corpus. - -- Keep the translated content up-to-date with your proposal. Propagate changes to all `readme.*.md` files. Rely on automatic translation tools. Bilingual contributors will refine the result later. - -## Linting - -Have your pull-request pass the [official Awesome List's linter](https://github.com/sindresorhus/awesome-lint). - -No extra work is required here as it is [already integrated by the way of GitHub actions](https://github.com/kdeldycke/awesome-billing/tree/main/.github/workflows). - -To run the linter locally, do: - -```shell-session -$ npm i npx -$ npx awesome-lint -``` - -## Formatting - -Additional rules not covered by `awesome-lint`, to keep the content clean and tidy. - -If one of these rule conflict with the linter, the linter's rule should takes precedence. Apply it. - -### General content - -- Remove any trailing whitespaces. - -- Use spaces, no tabs, for indention. - -- Apostrophes should be using the single ASCII mark: `'`. - -- Try to quote the original content as-is to summarize the point of the linked content. - -- If a straight quote doesn't cut it, feel free to paraphrase both the item's title and description. Remember, this is curation: we are increasing the value of the original content by aggregation and categorization. And also by smart editorializing. You just need to respect the spirit of the original content. - -### Sections - -- Sections are not in the alphabetical order, to provide a progression, from general to specific topics. - -- Section might feature one paragraph introduction and a figure (graph, drawing, photo). - -### Item title - -- URLs must use HTTPs protocol, if available. - -- No `“` and `”` curved quotation marks. This is reserved for original content quotation in descriptions. - -- To quote, use either the single or double variations: `'` and `"`. Keep them properly balanced. - -### Item description - -- Try to provide an actionable TL;DR as a description, quoting the original text if it stands by itself. - -- [Removes `TL;DR:` prefix in description](https://github.com/kdeldycke/awesome-billing/commit/d5496dda9ecb9c6aa1bc329c318caa07a7eeb020). Every description is a short summary anyway. - -- Quotes should be properly delimited with the `“` and `”` curved quotation marks. - -- You can reduce the original text by using an ellipsis in parenthesis `(…)`. - -- For quoting inside a quote, use single or double `'` and `"` ASCII marks. Keep them properly balanced. - -- To serialize a list into a description, use the following format: - - > Text of a description summarizing the item. And here is a list coming from the original content about **“a random subject: 1. Blah blah blah; 2. Blah blah blah? 3. Blah blah blah.”** And a bit more text to conclude. - - This format provides visual anchor points that help readability and quick content scanning. - - - You can skip some items from the original list and renumber it. - - - You shouldn't have to re-order it though. - -- An additional link in the description is allowed. This must be limited to some rare cases. Like pointing to a bigger concept, an acronym definition, or reference material (book, biography, …). - -### CLI helpers - -One-liners to fix-up some common formatting mistakes. Use with great caution and always double-check and edit the results. - -- Replaces star list item markers by dashes: - - ```shell-session - $ sed -i 's/^* /- /g' ./README.md - ``` - -- Replaces typographic quotes with ASCII ones: - - ```shell-session - $ sed -i "s/‘/\'/g" ./readme.md - $ sed -i "s/’/\'/g" ./readme.md - ``` - -- Forces quotes to end with a dot: - - ```shell-session - $ sed -i 's/`$/`\./g' ./readme.md - ``` - -[Other one-liners are available](https://kevin.deldycke.com/2006/12/text-date-document-processing-commands/) on my blog. diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml index 3b7bd65..e69de29 100644 --- a/.github/dependabot.yaml +++ b/.github/dependabot.yaml @@ -1,14 +0,0 @@ -# https://docs.github.com/en/github/administering-a-repository -# /configuration-options-for-dependency-updates ---- -version: 2 -updates: - - - package-ecosystem: "github-actions" - directory: "/" - schedule: - interval: "daily" - labels: - - "📦 dependencies" - assignees: - - "kdeldycke" diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 2595789..e69de29 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,25 +0,0 @@ -### Motivation - - - -This new link is special because... - -### Affiliation - - - -- [ ] I am the author of the article or project -- [ ] I am working for/with the company which is publishing the article or project -- [ ] I'm just a rando who stumbled upon this via social networks - -### Self checks - -- [ ] I have [read the Code of Conduct](https://github.com/kdeldycke/awesome-billing/blob/main/.github/code-of-conduct.md) -- [ ] I applied all rules from the [Contributing guide](https://github.com/kdeldycke/awesome-billing/blob/main/.github/contributing.md) -- [ ] I have checked there is no other [Issues](https://github.com/kdeldycke/awesome-billing/issues) or [Pull Requests](https://github.com/kdeldycke/awesome-billing/pulls) covering the same topic to open diff --git a/.github/workflows/autofix.yaml b/.github/workflows/autofix.yaml index 05fed5a..e69de29 100644 --- a/.github/workflows/autofix.yaml +++ b/.github/workflows/autofix.yaml @@ -1,13 +0,0 @@ ---- -name: Autofix -"on": - push: - # Only targets main branch to avoid amplification effects of auto-fixing - # the exact same stuff in multiple non-rebased branches. - branches: - - main - -jobs: - - autofix: - uses: kdeldycke/workflows/.github/workflows/autofix.yaml@v3.3.4 \ No newline at end of file diff --git a/.github/workflows/autolock.yaml b/.github/workflows/autolock.yaml index f7d2ba5..e69de29 100644 --- a/.github/workflows/autolock.yaml +++ b/.github/workflows/autolock.yaml @@ -1,11 +0,0 @@ ---- -name: Autolock -"on": - schedule: - # Run weekly, every Monday at 8:43. - - cron: "43 8 * * 1" - -jobs: - - autolock: - uses: kdeldycke/workflows/.github/workflows/autolock.yaml@v3.3.4 diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 3cff803..8f08a83 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -1,73 +1 @@ ---- -name: Docs -"on": - push: - # Only targets main branch to avoid amplification effects of auto-fixing - # the exact same stuff in multiple non-rebased branches. - branches: - - main - -jobs: - - #docs: - # uses: kdeldycke/workflows/.github/workflows/docs.yaml@v3.3.4 - - - awesome-template-sync: - name: Sync awesome template - if: > - startsWith(github.event.repository.name, 'awesome-') - && github.event.repository.name != 'awesome-template' - runs-on: ubuntu-22.04 - outputs: - pr_branch: ${{ steps.template_sync.outputs.pr_branch }} - steps: - - uses: actions/checkout@v4.1.1 - with: - # We need custom PAT with workflows permissions so we can update all the boilerplate .github files from - # awesome-template. - token: ${{ secrets.WORKFLOW_UPDATE_GITHUB_PAT || secrets.GITHUB_TOKEN }} - - name: Sync from template repo - id: template_sync - uses: AndreasAugustin/actions-template-sync@v1.8.0 - with: - # We need custom PAT with workflows permissions so we can update all the boilerplate .github files from - # awesome-template. - github_token: ${{ secrets.WORKFLOW_UPDATE_GITHUB_PAT || secrets.GITHUB_TOKEN }} - source_repo_path: kdeldycke/awesome-template - pr_title: "[sync] Updates from `awesome-template` repository" - pr_commit_msg: "[sync] Updates from `awesome-template` repository" - pr_branch_name_prefix: "sync-awesome-template" - pr_labels: "📚 documentation" - - # We need a new job to be able to re-call the actions/checkout action and fetch the new PR created above by - # actions-template-sync. This is a known limitation: https://github.com/actions/checkout/issues/439 - awesome-template-update: - name: Update awesome template - needs: - - awesome-template-sync - runs-on: ubuntu-22.04 - # XXX We could merge this second workflow to the one above if actions-template-sync support direct setup of hooks. - # This is being discussed at: https://github.com/AndreasAugustin/actions-template-sync/issues/467 - steps: - - name: Checkout template sync PR - uses: actions/checkout@v4.1.1 - with: - ref: ${{ needs.awesome-template-sync.outputs.pr_branch }} - fetch-depth: 0 - # We need custom PAT with workflows permissions so we can update all the boilerplate .github files from - # awesome-template. - token: ${{ secrets.WORKFLOW_UPDATE_GITHUB_PAT || secrets.GITHUB_TOKEN }} - - name: Update repo URLs - # Replace "/kdeldycke/awesome-template/" in URLs by "/kdeldycke/awesome-/". - run: > - find ./.github/ -type f -iregex '.*\.\(md\|yaml\)$' -print -exec sed --quiet -i - "s/\/kdeldycke\/awesome-template\//\/kdeldycke\/${{ github.event.repository.name }}\//gp" "{}" \; - - name: Push to PR - uses: peter-evans/create-pull-request@v6.0.1 - with: - # We need custom PAT with workflows permissions so we can update all the boilerplate .github files from - # awesome-template. - token: ${{ secrets.WORKFLOW_UPDATE_GITHUB_PAT || secrets.GITHUB_TOKEN }} - assignees: ${{ github.actor }} - commit-message: "[sync] Update template URLs" + # Replace "/kdeldycke/awesome-billing/" in URLs by "/kdeldycke/awesome-/". diff --git a/.github/workflows/label-sponsors.yaml b/.github/workflows/label-sponsors.yaml index 20ceecc..e69de29 100644 --- a/.github/workflows/label-sponsors.yaml +++ b/.github/workflows/label-sponsors.yaml @@ -1,14 +0,0 @@ ---- -name: Label sponsors -"on": - pull_request: - types: - - opened - issues: - types: - - opened - -jobs: - - label-sponsors: - uses: kdeldycke/workflows/.github/workflows/label-sponsors.yaml@v3.3.4 \ No newline at end of file diff --git a/.github/workflows/labels.yaml b/.github/workflows/labels.yaml index 0a305d4..e69de29 100644 --- a/.github/workflows/labels.yaml +++ b/.github/workflows/labels.yaml @@ -1,11 +0,0 @@ ---- -name: Labels -"on": - push: - branches: - - main - -jobs: - - labels: - uses: kdeldycke/workflows/.github/workflows/labels.yaml@v3.3.4 \ No newline at end of file diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index b705a4a..e69de29 100644 --- a/.github/workflows/lint.yaml +++ b/.github/workflows/lint.yaml @@ -1,9 +0,0 @@ ---- -name: Lint -"on": - push: - -jobs: - - lint: - uses: kdeldycke/workflows/.github/workflows/lint.yaml@v3.3.4 \ No newline at end of file