Skip to content

[TEST] Update JA gitbook with latest from main #454

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 125 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
125 commits
Select commit Hold shift + click to select a range
47937fa
Improving the docs of the book generation.
spier Jul 28, 2022
b33eb42
Improving the docs of the translation process
spier Jul 28, 2022
3d71897
Advertise pattern translations as one way to contribute to this repo
spier Jul 28, 2022
5133c80
lint: fix trailing spaces
spier Jul 28, 2022
174c3ff
Document another way to contribute: 'Confirm that you are using a pat…
spier Jul 30, 2022
87f22b7
Merge pull request #431 from InnerSourceCommons/improve-book-docs
yuhattor Aug 2, 2022
615e002
Introduce lychee link checker (instead of liche) (#436)
spier Aug 10, 2022
7fd95ae
Unify expression of Trusted Committer in Japanese
yuhattor Aug 21, 2022
1653773
Fix markdown error
yuhattor Aug 21, 2022
865c359
Create Board Report 2022-08 (#438)
spier Aug 21, 2022
9caf274
Setting URL for the Appendix section explicitly for the JP book (#441)
spier Aug 24, 2022
8f1d3c8
Merge pull request #440 from InnerSourceCommons/jp-translation-improv…
yuhattor Aug 31, 2022
b4ab070
Writing updated files for the book
yuhattor Aug 31, 2022
948a9c9
Add Airbus as known instance of the InnerSource Portal pattern (#446)
sicot-f Sep 1, 2022
0bd7aba
Pattern "Extensions to Manage Contributions at Scale" (#444)
Ssukriti Sep 5, 2022
732a4eb
Addding 'Extensions to Manage Contributions at Scale' pattern to READ…
spier Sep 5, 2022
abd1635
Mini formatting fix in main README
spier Sep 6, 2022
529dc6a
Moving Japanese content to `translation/ja` (#452)
spier Sep 15, 2022
5b1f6f1
Writing updated files for the book
spier Sep 15, 2022
3f06ebb
Update introducing-metrics-in-innersource.md (#455)
Trueblueaddie Sep 22, 2022
96f539a
Update introducing-metrics-in-innersource.md (#456)
guilhermebrasil Sep 23, 2022
88943dd
Add Modern Agile as an anchor to the Concept Anchor pattern (#457)
guilhermebrasil Sep 26, 2022
424db19
Use underscore for italics formatting (#459)
spier Sep 26, 2022
eb4de65
Correcting typo (#460)
claredillon Sep 27, 2022
c6461be
Add new images for Standard Base Documentation (#463)
spier Sep 30, 2022
a410adc
Create transitioning-contractor-code-to-innersource-model (#377)
claredillon Oct 10, 2022
f7c39e6
Re-creating markmap and screenshot
spier Oct 10, 2022
84584ad
Add pattern 'Transitioning Contractor Code to InnerSource Model' to R…
spier Oct 10, 2022
e02db63
Formatting changes to CONTRIBUTING.md (#468)
Mercysticks Oct 11, 2022
931a73d
Remove docs for office hours (#470)
spier Oct 11, 2022
9d2eb86
Link Check just for files in a PR (#471)
spier Oct 16, 2022
4eb7a91
Issue #464 Review & Improve our documentation for first-time contribu…
EliRen7 Oct 19, 2022
ea607cc
Minor grammar/spelling corrections. (#473)
stephenkilbaneadi Oct 20, 2022
0bc38f3
Update changed link (#477)
robtuley Nov 1, 2022
b5c152f
RFC Pattern - Adding Know Instance from DAZN (#416)
spier Nov 1, 2022
e6d1afe
Fix GHA deprecation warning (upgrade lychee-action to 1.5.2) (#476)
spier Nov 3, 2022
c710f8a
Add a chart to explain the levels of the mindmap (#480)
spier Nov 3, 2022
10eff3b
Fix mailto syntax (#481)
spier Nov 4, 2022
de3de6e
Add links to slack + book when creating an issue. Add link to Slack a…
spier Nov 9, 2022
bdc01b0
Add issue template for pattern draft (#483)
spier Nov 9, 2022
c7a09f1
Upgrade GHA workflows to latest actions and Node 16 (#484)
spier Nov 11, 2022
3241bbb
Fix link to book
spier Nov 15, 2022
76e0e3b
Improved description of 'naming patterns'
spier Nov 23, 2022
cb5b50d
Board Report 2022-11 (#486)
robtuley Nov 23, 2022
ec2b346
Extending Governance Levels (#357)
robtuley Nov 24, 2022
abd575c
pattern draft: Incubator Pipeline (#338)
gyehuda Nov 24, 2022
47045e8
Wording fix
spier Nov 25, 2022
678b118
Adding WellSky as a Known Instance to the Core Team pattern (#492)
spier Nov 26, 2022
66342e7
Tidy-up Incubator Pattern (#489)
robtuley Nov 27, 2022
22e3d52
Update link to Santander ONE Europe InnerSource Community (#496)
spier Dec 2, 2022
724b264
Mercado Libre as known instance of the InnerSource Portal pattern (#507)
privero-meli Dec 5, 2022
fa440ae
Add Mercado Libre as known instance of the Communication Tooling patt…
privero-meli Dec 5, 2022
09e8ed7
Mercado Libre as known instance of the Standard Base Documentation pa…
privero-meli Dec 5, 2022
0ff3925
Create innersource-customer-interview-questions.md (#485)
kschueths Dec 5, 2022
f461a33
List pattern from #485 in the main README. Thanks @kschueths.
spier Dec 5, 2022
83a9f3e
Mercado Libre as known instance of the Trusted Committer pattern (#505)
privero-meli Dec 6, 2022
4fece4c
Deduplicate entry for 'Time Constraints Hamper Inner Source Progress'…
spier Dec 6, 2022
c393464
Bump decode-uri-component from 0.2.0 to 0.2.2 in /pattern-categorizat…
dependabot[bot] Dec 14, 2022
f6611d4
Maturing the extensions pattern (#508)
Ssukriti Dec 21, 2022
2e2e497
Fix link/title/patlet of extensions pattern in README
spier Dec 21, 2022
d2e0775
Move extensions to Structured pattern (#512)
Ssukriti Dec 21, 2022
85a87d9
Re-creating markmap and screenshot
spier Dec 21, 2022
bb84394
Moving pattern to the right section in README
spier Dec 21, 2022
22e6a1b
Quick fix
spier Dec 21, 2022
0ebc0bd
Publishing patterns book in Chinese (zh) (#515)
spier Jan 4, 2023
3a6dab1
Writing updated files for the book
spier Jan 4, 2023
0cc1c4d
[Chinese translation] Fixed format typo of README.md (#520)
WillemJiang Jan 16, 2023
274b408
Writing updated files for the book
spier Jan 16, 2023
c452749
Adding permission of author acknowledgement to CONTRIBUTING.md (#522)
CiaraFlanagan Jan 24, 2023
00fde12
Add BBVA as known instance to Core Team pattern (#523)
rahermur Feb 2, 2023
f1f2eda
Fixing link to Slack inviter
spier Feb 14, 2023
043344e
Board Report 2023/02 (#525)
spier Feb 23, 2023
2eb1c0b
Improve Modular Code pattern (#475)
fioddor Mar 6, 2023
571a804
Add GitHub usage and perspective (#528)
zkoppert Mar 7, 2023
38d41d3
Improve 'Communication Tooling' pattern (#420)
spier Mar 9, 2023
10cae6b
Writing updated files for the book
spier Mar 9, 2023
4bc19e9
Add new Patlet to README
spier Mar 9, 2023
bd532d7
Introducing Metrics in InnerSource: Merge PR497 and PR501 upstream (i…
fioddor Mar 10, 2023
73499ff
Concept Anchor - Formal pattern improvements (#530)
fioddor Mar 10, 2023
bf274fd
Add further acknowledgements to introducing-metrics-in-innersource.md
spier Mar 11, 2023
66d447a
Fix linter issues
spier Mar 11, 2023
8e91c1c
Added Robert Bosch GmbH as known instance (#533)
gruetter Mar 14, 2023
b3bb4f7
Create new pattern: Support as a Group (#527)
rrrutledge Apr 4, 2023
06e6686
Writing updated files for the book
spier Apr 4, 2023
69da445
Add Group Support pattern to README
spier Apr 4, 2023
6f457ff
Script to find upgradeable patterns (#534)
spier May 12, 2023
5c3eb97
shared-code-repo-different-from-build-repo.md - Moved to InnerSource …
MaineC May 12, 2023
903c68c
Removing link to innersourceportal.santander.com (#539)
spier May 20, 2023
1d27905
Adding vale for spell and style checking (#519)
spier May 22, 2023
59c01a9
Writing updated files for the book
spier May 22, 2023
db15ee1
Board Report 2023-05 (#540)
spier May 25, 2023
4afeec8
Fixing link (#545)
spier Jun 16, 2023
9635fc4
Re-creating markmap and screenshot
spier Jun 16, 2023
b27512e
Add i18n consistency-checker
yuhattor Jun 18, 2023
fccd62b
Update to use i18n label for internationalization related issue
yuhattor Jun 18, 2023
55cbbc9
Initial Japanese Translation - extensions-for-sustainable-growth pattern
yuhattor Jun 18, 2023
2ccf254
Update links
yuhattor Jun 18, 2023
59b5a11
Update the wiki link to pass the link check
yuhattor Jun 18, 2023
94a5aae
Update Label Type - i18n-consistency-checker.yaml
yuhattor Jun 19, 2023
845cb29
Update Airbus implementation of the innersource portal pattern (#550)
sicot-f Jun 20, 2023
279c99f
Update translation/ja/patterns/extensions-for-sustainable-growth.md
yuhattor Jun 21, 2023
9abad41
Update translation/ja/patterns/extensions-for-sustainable-growth.md
yuhattor Jun 21, 2023
32f2860
Update translation/ja/patterns/extensions-for-sustainable-growth.md
yuhattor Jun 21, 2023
6c4c03f
Update translation/ja/patterns/extensions-for-sustainable-growth.md
yuhattor Jun 21, 2023
9941e90
Update translation/ja/patterns/extensions-for-sustainable-growth.md
yuhattor Jun 21, 2023
0266cca
Incorporated the review
yuhattor Jun 21, 2023
ab1cce3
Update Japanese translation
yuhattor Jun 21, 2023
11bc7eb
Update base-documentation.md, fix CONTRIBUTING spelling (#552)
jeffabailey Jun 26, 2023
243f4bc
Create COMMUNICATION-template.md (#557)
kschueths Jul 5, 2023
e936f17
Add Known Instance to service-vs-library.md (#559)
rrrutledge Jul 17, 2023
a171116
Update translation/ja/patterns/extensions-for-sustainable-growth.md
yuhattor Jul 19, 2023
cc8dc8f
Update translation/ja/patterns/extensions-for-sustainable-growth.md
yuhattor Jul 19, 2023
506cebf
Merge pull request #549 from InnerSourceCommons/adding-extensions-for…
yuhattor Jul 19, 2023
44fab36
Add Mercedes-Benz as known instance to innersource-portal.md (#561)
spier Jul 24, 2023
516a887
Use glob to select files to be checked by vale (#541)
spier Aug 2, 2023
ac724fc
Bump semver from 5.7.1 to 5.7.2 in /pattern-categorization (#558)
dependabot[bot] Aug 2, 2023
370cc98
Adding welcome bot + fix links to slack (#567)
spier Aug 9, 2023
9c3697a
Move Release Process pattern to L2 (Structured) (#524)
dgrizzanti Aug 9, 2023
3a50380
Writing updated files for the book
spier Aug 9, 2023
7aa4e06
Add GitHub to release-process as a known instance (#568)
zkoppert Aug 9, 2023
d8f253c
Re-creating markmap and screenshot
spier Aug 9, 2023
e744a71
Remove outdated link to 'release process' pattern. this has been upgr…
spier Aug 16, 2023
2adfa28
Porting board report for this WG here (#576)
spier Aug 22, 2023
32e6342
Change description of available languages, so that we don't have to c…
spier Aug 22, 2023
36e2ca8
Updating Japanese🇯🇵 / Chinese🇨🇳 page to the latest (#548)
yuhattor Aug 22, 2023
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions .gitbook.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
root : ./

structure:
readme: book/jp/introduction.md
summary: book/jp/toc.md

readme: book/en/introduction.md
summary: book/en/toc.md
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: true
contact_links:
- name: Slack
url: https://innersourcecommons.org/slack
about: Join our Community on Slack for help and a casual chat.
- name: Patterns Book
url: https://patterns.innersourcecommons.org
about: Read our most mature patterns here.
70 changes: 70 additions & 0 deletions .github/ISSUE_TEMPLATE/pattern-draft.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
---
name: Pattern Draft
about: Suggest a new Pattern
title: "[Pattern Draft]"
labels: 1-initial, Type - Content Work
assignees: ''

---

This is the most basic template for a new pattern.
See our full pattern syntax [here](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/meta/pattern-template.md).

## Title

Short Title Here

## Patlet / Summary

Concise 1-2 sentence description of the problem and solution.

## Problem

What is the problem - crisp definition of the problem.
Short description, usually not more than a couple sentences, that describes what the issues and challenges are.
Be careful not to morph into information found in other sections below.

## Context

Where does the problem exist?
What are the pre-conditions?
**Unchangeable** before the solution goes into place.
The content here is often tied to the applicability of the pattern for other readers: "Do I have this same particular situation?"

## Forces

What makes the problem difficult?
What are the trade-offs?
These are constraints that **can be changed** at a cost.
The solution might change one or more of these forces in order to solve the problem, while also in-turn changing the context.

## Solutions

Verified resolutions and possible resolutions to the problem.

## Resulting Context

What is the situation after the problem has been solved?
The original context is changed indirectly by way of the solution.
Often this section can include discussion of the next possible Patterns/problems introduced.
This section can be short in content - the solution may not introduce new problems or change much context.

## Known Instances (optional)

Where has this been seen before?
Helps to reinforce that this is a REAL pattern and that you match the context.

May mention:

* A particular business
* Anonymized instances ex: "3 companies have proven that this is a good solution" or "A large financial services org...".

## Status

Initial

## Author(s) (optional)

Often, this is yourself.
If you need to, find someone in the InnerSource Commons to be the nominal author (As Told To).
Could also be no-one if you do not want to take on authorship (common with a donut looking for a solution).
44 changes: 44 additions & 0 deletions .github/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Configuration for welcome - https://github.com/behaviorbot/welcome

# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome

# Comment to be posted to on first time issues
newIssueWelcomeComment: >
[![Welcome Banner](https://zenodo.org/api/iiif/v2/0c0188d3-d03c-4830-a6e3-00405f5c22fa:8ff47a85-7250-4d86-8e48-2f346b48b2c1:BannerWelcome.jpg/full/750,/0/default.jpg)](https://zenodo.org/record/3695300)

:tada: Welcome to _The InnerSource Commons_ community, and in particular to our patterns! :tada:
We're really excited to have your input into the project! :sparkling_heart:

<br>If you haven't done so already, please check out our [Contributing Guidelines](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/CONTRIBUTING.md).
If you need to connect more synchronously with members of _The InnerSource Commons_ community, come chat with us in our [Slack workspace](https://innersourcecommons.org/slack).

# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome

# Comment to be posted to on PRs from first time contributors in your repository
newPRWelcomeComment: >
[![Thank You Banner](https://zenodo.org/api/iiif/v2/0c0188d3-d03c-4830-a6e3-00405f5c22fa:7fbd97cf-283b-480c-b8e1-11866e26245c:BannerThanks.jpg/full/750,/0/default.jpg)](https://zenodo.org/record/3695300)

:sparkling_heart: Thanks for opening this pull request! :sparkling_heart:
_The InnerSource Commons_ community really appreciates your time and effort to contribute to the project.
Please make sure you have read our [Contributing Guidelines](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/CONTRIBUTING.md).

If you are submitting a new pattern, the following things will help get your pull request across the finish line! :checkered_flag:

- Check you have used our [pattern template](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/meta/pattern-template.md) and removed any placeholder text and sections that your pattern did not need.

- We will run a number of automated checks on your PR. Please review the output of those checks on the PR itself, and see if any issues got flagged that you can fix yourself.

- Make sure you have added your new pattern to the list of patterns in the main [README.md](https://github.com/InnerSourceCommons/InnerSourcePatterns/blob/main/README.md). If you are unsure where to add your pattern, no worries. Just let us know on the PR and we will help you.

<br>This project has a small number of maintainers, volunteering their time to this project. So please be patient and we will get back to you as soon as we can.
If we don't acknowledge this pull request after 7 days, feel free to chat to us about it in our [Slack workspace](https://innersourcecommons.org/slack).

# Configuration for first-pr-merge - https://github.com/behaviorbot/first-pr-merge

# Comment to be posted to on pull requests merged by a first time user
firstPRMergeComment: >
[![Congratulations Banner](https://zenodo.org/api/iiif/v2/0c0188d3-d03c-4830-a6e3-00405f5c22fa:32fbdb89-ae1b-434e-830c-88ade86724cc:BannerCongratulations.jpg/full/750,/0/default.jpg)](https://zenodo.org/record/3695300)

Congrats on merging your first pull request! :tada:
We here at _The InnerSource Commons_ are proud of you! :sparkling_heart:
Thank you so much for your contribution :gift:
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion .github/workflows/book.yml
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ jobs:

- name: Determine book language
run: |
[[ "$GITHUB_REF_NAME" == "book-jp" ]] && book_language="jp" || book_language="en"
[[ "$GITHUB_REF_NAME" =~ ^book-.*$ ]] && book_language=${GITHUB_REF_NAME:5:2} || book_language="en"
echo "BOOK_LANGUAGE=$book_language" >> $GITHUB_ENV

- name: Generate ToC
Expand Down
6 changes: 3 additions & 3 deletions .github/workflows/generate-mindmap.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@ jobs:
generate-mindmap:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3
- name: Use Node.js
uses: actions/setup-node@v2
uses: actions/setup-node@v3
with:
node-version: 12.x
node-version: 16
cache: 'npm'
cache-dependency-path: pattern-categorization/package-lock.json
- name: Install Node.js dependencies
Expand Down
104 changes: 104 additions & 0 deletions .github/workflows/i18n-consistency-checker.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
name: i18n check consistency and notify on GitHub Issues

on:
pull_request:
branches:
- master
paths:
- .github/workflows/i18n-consistency-check.yml
schedule:
- cron: '0 0 1 * *'
workflow_dispatch:

jobs:
consistency-check:
runs-on: ubuntu-latest
strategy:
matrix:
language: [ja, zh]
steps:
- uses: actions/checkout@v2
with:
fetch-depth: '0'
- name: Check consistency
id: check-consistency
run: |
# Set the issue header
issue="\
# i18n Contents Consistency Issue\\n\
\\n\
The following files may have consistency issues with the English version. Please check and update the files.\\n\
\\n\
This issue is created when there is an update to content/en. It compares the git update history to let you know what updates are overdue. The issue should be closed when the update is complete.\\n"

for file in $(find patterns/2-structured -name '*.md'); do

# Get the translated file name and check if it exists
i18n_filename=$(echo "$file" | sed 's/patterns\/2-structured/translation\/${{matrix.language}}\/patterns/g')
if [[ ! -e "$i18n_filename" ]]; then
continue
fi
echo $file
echo $i18n_filename
# Loop through all the files in the English directory
# Get the last updated date of the original file and the translated file
original_updated_at=$(date -d "$(git log -1 --format=%cd --date=iso $file)" +%s)
i18n_content_updated_at=$(date -d "$(git log -1 --format=%cd --date=iso $i18n_filename)" +%s)

# print the last updated date of the original file and the translated file

# Check if the translated file is updated after the original file
if [[ $(($original_updated_at - $i18n_content_updated_at)) -ge 1 ]]; then
# Get the title of the content
content_header=$(echo "$(cat "$file")" | grep -E '^title+' | sort -r | head -n1)
content_title=$(echo "$content_header" | sed 's/title: //g')

# Get the days since the translated file is overdue
days_since_overdue_updates=$(($(( $(date +%s) - $original_updated_at))/ 60 / 60 / 24))
# Get the diff between the original file and the translated file
original_last_update_hash=$(git log -1 --format=%H $file)
# Get the parent hash of the original last update hash
parent_hash=$(git log -1 --format=%P $original_last_update_hash)
# Get the diff between the original file and the translated file

result=$(echo "$(git diff ${parent_hash} HEAD $file)" | sed '1,4 s/^/# /')
echo -e "$result"

# Add the contents to the issue.md file
issue+="<details><summary><b>$content_title</b> ($file)</summary>\\n\\n"
issue+="- Original File(en): [$file](https://github.com/$GITHUB_REPOSITORY/blob/master/$file)\\n"
issue+="- Translated File(${{matrix.language}}): [$i18n_filename](https://github.com/$GITHUB_REPOSITORY/blob/master/$i18n_filename)\\n"
issue+="- [Diff on GitHub](https://github.com/yuhattor/innersourcecommons.org/compare/$i18n_last_update_hash...$original_last_update_hash)\\n"
issue+="- Days since overdue updates: $days_since_overdue_updates days\\n"
issue+="\`\`\`diff\\n"
issue+="$result"
issue+="\\n\`\`\`\\n"
issue+="</details>\\n"
echo -e "$issue" >> issue.md
issue=""
fi
done
- name: Create Issue
run: |
# Declare the flags
declare -A flags=(
["ja"]="🇯🇵 Japanese"
["zh"]="🇨🇳 Chinese"
)

# Set the issue title
issue_title="${flags[${{matrix.language}}]}: Content Consistency Issue"

# Get the existing issue ID
existing_issue_id=$(gh issue list -S "state:open type:issue title:$issue_title" | cut -f1)

# If the issue.md file exists, create a new issue or comment on the existing issue
if [ -f issue.md ]; then
if expr "$existing_issue_id" : '^[0-9]*$' >/dev/null; then
gh issue comment "$existing_issue_id" -F issue.md -R $GITHUB_REPOSITORY
else
gh issue create -t "$issue_title" -F issue.md -R $GITHUB_REPOSITORY -l "Type - Translation"
fi
fi
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
46 changes: 46 additions & 0 deletions .github/workflows/link-checker-prs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# This link check is run on all PRs but just for the files that were changed/added in the PR itself.
# Otherwise we had it too often that PR authors would see a failing link check that had nothing to do with their PR.

name: Link Check PR

on:
push:
branches:
- main
pull_request:
branches:
- main

jobs:
linkChecker:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Get changed files
id: changed-files
uses: tj-actions/changed-files@v32

- name: Filter markdown files only
run: |
md_files=`find ${{ steps.changed-files.outputs.all_changed_files }} -maxdepth 0 -name "*.md" | tr '\n' ' '`
echo "MARKDOWN_FILES=$md_files" >> $GITHUB_ENV

- name: Restore lychee cache
uses: actions/cache@v3
with:
path: .lycheecache
key: cache-lychee-${{ github.sha }}
restore-keys: cache-lychee-

- if: ${{ env.MARKDOWN_FILES != '' }}
name: Link Checker
uses: lycheeverse/lychee-action@v1.5.2
with:
args: --verbose --no-progress --exclude-mail --cache --max-cache-age 1d $MARKDOWN_FILES
fail: true
jobSummary: true
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
39 changes: 23 additions & 16 deletions .github/workflows/link-checker.yml
Original file line number Diff line number Diff line change
@@ -1,26 +1,33 @@
# from: https://github.com/marketplace/actions/link-checker
# link checker used is 'liche': https://github.com/raviqqe/liche
# This link check is run on all content files once per day.

name: Link Check on Patterns and README
# from: https://github.com/lycheeverse/lychee-action
# link checker used is 'lychee': https://github.com/lycheeverse/lychee

name: Link Check

on:
push:
branches:
- "main"
pull_request:
schedule:
# * is a special character in YAML so you have to quote this string
- cron: '30 8 * * *'
- cron: '30 8 * * 5'

jobs:
linkChecker:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Link Checker
id: lc
uses: peter-evans/link-checker@v1
with:
args: -v -d . -x "http://creativecommons.org/licenses|https://isc-inviter.herokuapp.com|https://github.com/rcs/rcs-viewer/pull/81|fearlesschangepatterns.com|https://ulir.ul.ie/bitstream/handle/10344/4443/Stol_2014_inner.pdf|https://docs.github.com/en/rest/metrics/statistics|https://docs.github.com/en/rest/search#search-repositories" README.md patterns/ book/ translation/ -r
- name: Fail if there were link errors
run: exit ${{ steps.lc.outputs.exit_code }}
- uses: actions/checkout@v3

- name: Restore lychee cache
uses: actions/cache@v3
with:
path: .lycheecache
key: cache-lychee-${{ github.sha }}
restore-keys: cache-lychee-

- name: Link Checker
uses: lycheeverse/lychee-action@v1.5.2
with:
args: --verbose --no-progress --exclude-mail --cache --max-cache-age 1d README.md patterns/ book/ translation/
fail: true
jobSummary: true
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
12 changes: 7 additions & 5 deletions .github/workflows/lint-patterns.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
# from: https://github.com/marketplace/actions/markdown-linting-action
# To test this locally, switch to the root of the repo and run:
# markdownlint -r config/lint/pattern-template.js -c config/lint/pattern-template.yml patterns/2-structured/*.md patterns/2-structured/project-setup/*.md patterns/3-validated/*.md
name: Pattern Syntax Validation

on:
Expand All @@ -8,7 +10,7 @@ on:
pull_request:
paths:
- ".github/workflows/lint-patterns.yml"
- "lint/*"
- ".github/lint-pattern-syntax/*"
- "patterns/2-structured/*.md"
- "patterns/2-structured/project-setup/*.md"
- "patterns/3-validated/*.md"
Expand All @@ -17,12 +19,12 @@ jobs:
validate:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3
- name: Problem Matcher for markdownlint-cli
uses: xt0rted/markdownlint-problem-matcher@v1
uses: xt0rted/markdownlint-problem-matcher@v2
- name: Lint pattern files (markdown)
uses: avto-dev/markdown-lint@v1
with:
rules: './lint/pattern-template.js'
config: './lint/pattern-template.yml'
rules: './.github/lint-pattern-syntax/pattern-template.js'
config: './.github/lint-pattern-syntax/pattern-template.yml'
args: 'patterns/2-structured/*.md patterns/2-structured/project-setup/*.md patterns/3-validated/*.md'
Loading