Skip to content

Commit 2cf8bf2

Browse files
lbroudouxlbroudoux
committed
Revert "Publishing site Mar 4 jui 2024 10:20:16 CEST"
This reverts commit b65dc30.
1 parent b65dc30 commit 2cf8bf2

File tree

1,868 files changed

+36078
-4980219
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,868 files changed

+36078
-4980219
lines changed

‎.github/contribution_message.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
## 🌟 Join Us in Keeping Our Website Up-to-Date and Error-Free! 🚀
2+
3+
Dear Community Members,
4+
5+
We're on a mission to maintain our website, [microcks.io](https://microcks.io/), in top-notch condition, ensuring that it remains a valuable resource for everyone. To achieve this goal, we need your help!
6+
7+
### Why Contribute?
8+
- **Ensure Quality**: By collectively maintaining the website, we can promptly address broken links and outdated content, ensuring a seamless browsing experience for all visitors.
9+
10+
- **Stay Relevant**: Regular updates keep our content fresh and relevant, reflecting the latest developments in our field.
11+
12+
- **Community Engagement**: Contributing allows you to be an active part of our community, sharing and collaborating with fellow enthusiasts.
13+
14+
### How to Contribute?
15+
- **One PR Per File**: For ease of collaboration and review, please create one pull request per corrected file.
16+
17+
- **Tag Issue Number**: Always tag the issue number (#??) in your pull request description to associate it with the relevant issue.
18+
19+
- **Verify Links**: If you encounter rate limit errors for LinkedIn or GitHub profiles, click on the link, verify its accuracy, and update the [.lycheeignore](https://github.com/microcks/microcks.io/blob/master/.lycheeignore) file accordingly to prevent future error reporting.
20+
21+
Let's work together to maintain the excellence of our website! Your contributions make a real difference. 🌟
22+
23+
Happy Contributing! 🎉
24+
25+
Warm Regards,\
26+
Yacine

‎.github/dependabot.yml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# Automatically keep your GitHub actions up-to-date, thanks to dependabot
2+
3+
version: 2
4+
5+
updates:
6+
# Keep dependencies for GitHub Actions up-to-date
7+
- package-ecosystem: 'github-actions'
8+
directory: '/'
9+
schedule:
10+
interval: 'daily'

‎.github/workflows/external-link-check-refactor-doc-org.yml

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
# This link checks Microcks website links in Markdown HTML files once per day
2+
# from: https://github.com/lycheeverse/lychee-action
3+
# link checker used is 'lychee': https://github.com/lycheeverse/lychee
4+
5+
name: External Link Check Refactor Doc
6+
on:
7+
# This event will only trigger a workflow run if the workflow file is on the default branch.
8+
# ucomment the following line if you want to run the workflow manually
9+
# workflow_dispatch:
10+
# Run every day at 00h42 UTC (0:42 AM UTC aka 1:42 AM CEST with daylight saving time)
11+
schedule:
12+
- cron: "42 0 * * *"
13+
14+
jobs:
15+
linkChecker:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- name: Checkout repository
19+
uses: actions/checkout@v4
20+
with:
21+
ref: refactor-doc-org
22+
23+
# Setup local cache in order to mitigate issues regarding rate limiting or to reduce stress on external resources
24+
# Restore the lychee cache if it exists for the current commit
25+
- name: Restore lychee cache
26+
id: restore-cache
27+
uses: actions/cache/restore@v4
28+
with:
29+
path: .lycheecache
30+
key: cache-lychee-${{ github.sha }}
31+
restore-keys: cache-lychee-
32+
33+
# We do not need to build the site, so we can remove the Hugo build steps, thanks to the hugo check validation on push
34+
# However, retaining this comment for documentation purposes, just in case ;)
35+
36+
# Link Checker run with lychee action
37+
- name: Link Checker
38+
id: lychee
39+
uses: lycheeverse/lychee-action@v1
40+
with:
41+
# Check all markdown and html files in repo
42+
# Exclude all files except those starting with http:// or https:// thanks to the --scheme option
43+
# Use cache but cache the results for 8 hours
44+
args: --base public --verbose --no-progress './**/*.md' './**/*.html' --scheme https --scheme http --cache --max-cache-age 8h
45+
# Use markdown as output format
46+
format: markdown
47+
# Use different output file path
48+
output: ./link-checker/report.md
49+
# Use a custom GitHub token to "avoid" rate limiting
50+
token: ${{ secrets.CUSTOM_TOKEN }}
51+
# Don't fail action on broken links
52+
fail: false
53+
54+
# Format the date for the issue title and store it in an environment variable
55+
- name: Format Date
56+
id: format_date
57+
run: echo "DATE=$(date +'%A, %e. %b %Y')" >> $GITHUB_ENV
58+
59+
# Create an issue if there are broken links
60+
- name: Create Issue From File
61+
if: env.lychee_exit_code != 0
62+
id: create_issue
63+
uses: peter-evans/create-issue-from-file@v5
64+
with:
65+
title: "External Link Check Refactor Doc Report - ${{ env.DATE }}"
66+
content-filepath: ./link-checker/report.md
67+
labels: report, automated issue, contribution message, help wanted
68+
69+
# Store the issue number in an environment variable
70+
- name: Store Issue Number
71+
if: steps.create_issue.outputs.issue-number
72+
run: echo "ISSUE_NUMBER=${{ steps.create_issue.outputs.issue-number }}" >> $GITHUB_ENV
73+
74+
# Add a comment to the issue with the contribution message
75+
- name: Add contribution message as new comment
76+
if: ${{ env.ISSUE_NUMBER }} is not null
77+
run: gh issue comment "$NUMBER" --body-file "$BODY"
78+
env:
79+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
80+
GH_REPO: ${{ github.repository }}
81+
NUMBER: ${{ env.ISSUE_NUMBER }}
82+
BODY: ".github/contribution_message.md"
83+
84+
# Save the lychee cache for the next run
85+
- name: Save lychee cache
86+
uses: actions/cache/save@v4
87+
if: always()
88+
with:
89+
path: .lycheecache
90+
key: ${{ steps.restore-cache.outputs.cache-primary-key }}

‎.github/workflows/external-link-check.yml

Lines changed: 88 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
# This link checks Microcks website links in Markdown HTML files once per day
2+
# from: https://github.com/lycheeverse/lychee-action
3+
# link checker used is 'lychee': https://github.com/lycheeverse/lychee
4+
5+
name: External Link Check
6+
on:
7+
# This event will only trigger a workflow run if the workflow file is on the default branch.
8+
# ucomment the following line if you want to run the workflow manually
9+
# workflow_dispatch:
10+
# Run every day at 00h42 UTC (0:42 AM UTC aka 1:42 AM CEST with daylight saving time)
11+
schedule:
12+
- cron: "42 0 * * *"
13+
14+
jobs:
15+
linkChecker:
16+
runs-on: ubuntu-latest
17+
steps:
18+
- name: Checkout repository
19+
uses: actions/checkout@v4
20+
21+
# Setup local cache in order to mitigate issues regarding rate limiting or to reduce stress on external resources
22+
# Restore the lychee cache if it exists for the current commit
23+
- name: Restore lychee cache
24+
id: restore-cache
25+
uses: actions/cache/restore@v4
26+
with:
27+
path: .lycheecache
28+
key: cache-lychee-${{ github.sha }}
29+
restore-keys: cache-lychee-
30+
31+
# We do not need to build the site, so we can remove the Hugo build steps, thanks to the hugo check validation on push
32+
# However, retaining this comment for documentation purposes, just in case ;)
33+
34+
# Link Checker run with lychee action
35+
- name: Link Checker
36+
id: lychee
37+
uses: lycheeverse/lychee-action@v1
38+
with:
39+
# Check all markdown and html files in repo
40+
# Exclude all files except those starting with http:// or https:// thanks to the --scheme option
41+
# Use cache but cache the results for 8 hours
42+
args: --base public --verbose --no-progress './**/*.md' './**/*.html' --scheme https --scheme http --cache --max-cache-age 8h
43+
# Use markdown as output format
44+
format: markdown
45+
# Use different output file path
46+
output: ./link-checker/report.md
47+
# Use a custom GitHub token to "avoid" rate limiting
48+
token: ${{ secrets.CUSTOM_TOKEN }}
49+
# Don't fail action on broken links
50+
fail: false
51+
52+
# Format the date for the issue title and store it in an environment variable
53+
- name: Format Date
54+
id: format_date
55+
run: echo "DATE=$(date +'%A, %e. %b %Y')" >> $GITHUB_ENV
56+
57+
# Create an issue if there are broken links
58+
- name: Create Issue From File
59+
if: env.lychee_exit_code != 0
60+
id: create_issue
61+
uses: peter-evans/create-issue-from-file@v5
62+
with:
63+
title: "External Link Check Report - ${{ env.DATE }}"
64+
content-filepath: ./link-checker/report.md
65+
labels: report, automated issue, contribution message, help wanted
66+
67+
# Store the issue number in an environment variable
68+
- name: Store Issue Number
69+
if: steps.create_issue.outputs.issue-number
70+
run: echo "ISSUE_NUMBER=${{ steps.create_issue.outputs.issue-number }}" >> $GITHUB_ENV
71+
72+
# Add a comment to the issue with the contribution message
73+
- name: Add contribution message as new comment
74+
if: ${{ env.ISSUE_NUMBER }} is not null
75+
run: gh issue comment "$NUMBER" --body-file "$BODY"
76+
env:
77+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
78+
GH_REPO: ${{ github.repository }}
79+
NUMBER: ${{ env.ISSUE_NUMBER }}
80+
BODY: "./.github/contribution_message.md"
81+
82+
# Save the lychee cache for the next run
83+
- name: Save lychee cache
84+
uses: actions/cache/save@v4
85+
if: always()
86+
with:
87+
path: .lycheecache
88+
key: ${{ steps.restore-cache.outputs.cache-primary-key }}

‎.github/workflows/hugo-build-status-check.yml

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
# This GitHub Action builds and serves a Hugo website, checking for build errors on each push to the master branch.
2+
# The build status is checked, and if the build fails, the commit is blocked.
3+
4+
name: Hugo Build and Status Check
5+
6+
# Trigger the workflow on push events to the main branch
7+
on:
8+
push:
9+
branches:
10+
- master
11+
12+
jobs:
13+
build:
14+
# Use the latest version of Ubuntu as the runner
15+
runs-on: ubuntu-latest
16+
17+
# Steps to be executed as part of the job
18+
steps:
19+
# Step to checkout the repository
20+
- name: Checkout repository
21+
uses: actions/checkout@v4
22+
23+
# Step to set up Hugo
24+
- name: Setup Hugo
25+
uses: peaceiris/actions-hugo@v3
26+
with:
27+
# Always use the latest version of Hugo, in case of issue with the latest version,
28+
# you can specify a specific version using '0.125.5'
29+
hugo-version: 'latest'
30+
# Set the extended option to true to install the extended version of Hugo, mandatory for Microcks website
31+
extended: true
32+
33+
# Step to build the site
34+
- name: Build site
35+
run: hugo --minify
36+
# Capture output and error code
37+
continue-on-error: true
38+
id: build
39+
40+
# Step to start Hugo server in the background
41+
- name: Start Hugo server
42+
run: hugo server --minify --port=8888 &
43+
44+
# Check if build failed
45+
- name: Check build status
46+
run: |
47+
if [ ${{ steps.build.outcome }} != 'success' ]; then
48+
echo "::error::Hugo build failed, blocking commit..."
49+
exit 1
50+
fi
51+
52+
# Stop the Hugo server at the end of the workflow as is running in the background
53+
- name: Stop Hugo server
54+
run: kill $(lsof -t -i:8888) || true

‎.gitignore

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Generated files by hugo
2+
/public/
3+
/resources/_gen/
4+
assets/jsconfig.json
5+
hugo_stats.json
6+
7+
# Executable may be added to repository
8+
hugo.exe
9+
hugo.darwin
10+
hugo.linux
11+
12+
# Temporary lock file while building
13+
/.hugo_build.lock
14+
15+
# Ignore these files
16+
node_modules
17+
.DS_Store
18+
*.log
19+

‎.gitmodules

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
[submodule "public"]
2+
path = public
3+
url = https://github.com/microcks/microcks.github.io.git
4+
branch = master

‎.lycheeignore

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# These links are ignored by our link checker https://github.com/lycheeverse/lychee
2+
# The file allows you to list multiple regular expressions for exclusion (one pattern per line).
3+
4+
# Ignore Google fonts performance optimization (DNS PREFETCH on PRECONNECT): fault positive
5+
https://fonts.gstatic.com/
6+
https://use.fontawesome.com/
7+
8+
# Exclude localhost:8080 as it is consistently linked to docker-compose, which is ok.
9+
# Any other ports should be regarded as suspicious and undergo examination by the checker.
10+
http://localhost:8080/
11+
12+
# Exclude GitHub profiles that are accurate and have been manually verified to prevent error reporting
13+
# caused by GitHub rate limits, ex: "Failed: Network error: Too Many Requests"
14+
https://github.com/sarasensible
15+
https://github.com/MathisGoichon
16+
https://github.com/sbonaiva
17+
https://github.com/Feasoron
18+
https://github.com/lennakai
19+
https://github.com/sbr82
20+
https://github.com/molteninjabob
21+
https://github.com/dalelane
22+
https://github.com/Apoorva64
23+
https://github.com/pcuriel
24+
https://github.com/spencer-cheng
25+
https://github.com/dorianbrun
26+
https://github.com/JasonMiesionczek
27+
https://github.com/timchase01
28+
https://github.com/jonaslagoni
29+
https://github.com/redben
30+
https://github.com/imod
31+
32+
# Exclude LinkedIn profiles that are accurate and have been manually verified to prevent error reporting
33+
# caused by LinkedIn rate limits, ex: "Failed: Network error: Too Many Requests"
34+
https://www.linkedin.com/in/appadoo-apoorva-srinivas-481367207/
35+
https://www.linkedin.com/in/rquinio/
36+
https://www.linkedin.com/in/tsiry-sandratraina/
37+
https://www.linkedin.com/in/janschenk/
38+
https://www.linkedin.com/in/ankit-sobti/
39+
https://www.linkedin.com/in/kinlane/
40+
https://www.linkedin.com/in/joshgav/
41+
https://www.linkedin.com/in/abhinavasthana/
42+
https://www.linkedin.com/in/colin-e-griffin/

0 commit comments

Comments
 (0)