Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/workflows/auto_add_project.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ jobs:
steps:
- uses: actions/add-to-project@v0.5.0
with:
project-url: https://github.com/orgs/push-protocol/projects/10
project-url: https://github.com/orgs/pushchain/projects/10
github-token: ${{ secrets.ADD_TO_PROJECT_PAT }}
91 changes: 91 additions & 0 deletions .github/workflows/check-links.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
name: Check Links

on:
pull_request:
branches:
- main
- dev
paths:
- '**.md'
- '**.mdx'
- 'docs/**'
push:
branches:
- main
schedule:
# Run weekly on Mondays at 9 AM UTC
- cron: '0 9 * * 1'
workflow_dispatch:

jobs:
check-links:
runs-on: ubuntu-latest
name: Check for broken links

steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 1

- name: Check links in Markdown files
uses: lycheeverse/lychee-action@v2
with:
# Check all markdown files in the repository
args: |
--verbose
--no-progress
--max-retries 3
--timeout 20
--exclude-mail
--exclude-path node_modules
--exclude-path .git
--exclude-path build
--exclude-path dist
--exclude 'linkedin.com/in/*'
--exclude 'twitter.com/*'
--exclude 'x.com/*'
'**/*.md'
'**/*.mdx'

# Fail action on broken links
fail: true

# Output file for results
output: lychee-results.md

# Format of the output
format: markdown

- name: Create Issue on Failure
if: failure()
uses: peter-evans/create-issue-from-file@v5
with:
title: 'Broken Links Detected'
content-filepath: lychee-results.md
labels: |
documentation
bug

- name: Upload link check results
if: always()
uses: actions/upload-artifact@v4
with:
name: link-check-results
path: lychee-results.md
retention-days: 30

- name: Comment PR with results
if: github.event_name == 'pull_request' && failure()
uses: actions/github-script@v7
with:
script: |
const fs = require('fs');
const results = fs.readFileSync('lychee-results.md', 'utf8');

github.rest.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: `## ⚠️ Broken Links Detected\n\n${results}\n\nPlease fix these broken links before merging.`
});
16 changes: 16 additions & 0 deletions .lycheeignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Ignore social media profile links (they often block bots)
https://twitter.com/*
https://x.com/*
https://linkedin.com/*
https://facebook.com/*

# Ignore localhost links
http://localhost*
http://127.0.0.1*

# Ignore example/placeholder URLs
https://example.com/*

# Ignore any authentication-required URLs
**/login
**/signin
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,9 @@ Click on the packages to view more details.

- **[Website](https://push.org)** To checkout our Product.
- **[Docs](https://push.org/docs)** For comprehensive documentation.
- **[Blog](https://medium.com/push-protocol)** To learn more about our partners, new launches, etc.
- **[Blog](https://medium.com/pushchain)** To learn more about our partners, new launches, etc.
- **[Discord](https://discord.com/invite/pushchain)** for support and discussions with the community and the team.
- **[GitHub](https://github.com/push-protocol)** for source code, project board, issues, and pull requests.
- **[GitHub](https://github.com/pushchain)** for source code, project board, issues, and pull requests.
- **[X/Twitter](https://x.com/pushchain)** for the latest updates on the product and published blogs.

## Contributing
Expand All @@ -56,7 +56,7 @@ Push Protocol is an open source Project. We firmly believe in a completely trans
- Feature Request: Please submit a feature request if you have an idea or discover a capability that would make development simpler and more reliable.
- Documentation Request: If you're reading the Push documentation and believe that we're missing something, please create a docs request.

<!-- Read how you can contribute <a href="https://github.com/push-protocol/push-chain-sdk/blob/main/CONTRIBUTING.md
<!-- Read how you can contribute <a href="https://github.com/pushchain/push-chain-sdk/blob/main/CONTRIBUTING.md
">HERE</a> -->

Not sure where to start? Join our discord and we will help you get started!
Expand Down