Skip to content
Merged
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
20 changes: 16 additions & 4 deletions .github/workflows/broken_links_checker.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,30 +4,42 @@ on:
push:
branches: [main]
pull_request:
schedule:
- cron: "0 4 * * 1"
workflow_dispatch:

jobs:
linkChecker:
runs-on: ubuntu-latest
permissions:
contents: read
concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true
steps:
- uses: actions/checkout@v7
with:
persist-credentials: false
# Asset directories in agent skills contain template relative links that only resolve when applied by the skill.
- name: Exclude skill asset directories
run: |
find . -type d \( -path '*/.agents/skills/*/assets*' -o -path '*/.agent/skills/*/assets*' \) -prune -exec rm -rf {} +
# The Autosar TLS certificate cannot be validated from GitHub Actions.
- name: Configure broken links checker
run: |
mkdir -p ./target
echo '{
cat << 'EOF' > ./target/broken_links_checker.json
{
"aliveStatusCodes": [429, 200],
"ignorePatterns": [
{
# The Autosar TLS certificate cannot be validated from GitHub Actions.
"pattern": "^https://www.autosar.org/"
}
]
}' > ./target/broken_links_checker.json
}
EOF
- uses: tcort/github-action-markdown-link-check@e047c5b37f24ab722bbef1a27b6fab7f96bc4068
with:
use-quiet-mode: "yes"
use-verbose-mode: "yes"
use-verbose-mode: "no"
config-file: ./target/broken_links_checker.json
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ Sonarcloud status:

If you want to use OFT, you have the choice between using it as part of your build process — typically with Maven or Gradle. Or you can run OFT from the command line.

Check the [user guide](https://openfasttrace.itsallcode.org/user_guide/user_guide.md) for detailed information on how to use OpenFastTrace.
Check the [user guide](https://openfasttrace.itsallcode.org/user_guide/user_guide.html) for detailed information on how to use OpenFastTrace.

## Installation

Expand All @@ -84,7 +84,7 @@ Note that only the latest version of OFT is actively supported.

### Installation

You can get OFT via our [Debian APT repository](https://itsallcode/itsallcode-apt-repository), through [Homebrew](https://formulae.brew.sh/formula/openfasttrace), as [Maven plugin](https://central.sonatype.com/artifact/org.itsallcode/openfasttrace-maven-plugin) or [Gradle plugin](https://plugins.gradle.org/plugin/org.itsallcode.openfasttrace). Or you can get the [jar archive]((https://docs.oracle.com/javase/8/docs/technotes/guides/jar/jar.html#JAR%20Manifest)) via [releases on GitHub](releases).
You can get OFT via our [Debian APT repository](https://github.com/itsallcode/itsallcode-apt-repository), through [Homebrew](https://formulae.brew.sh/formula/openfasttrace), as [Maven plugin](https://central.sonatype.com/artifact/org.itsallcode/openfasttrace-maven-plugin) or [Gradle plugin](https://plugins.gradle.org/plugin/org.itsallcode.openfasttrace). Or you can get the [jar archive](https://docs.oracle.com/javase/8/docs/technotes/guides/jar/jar.html#JAR%20Manifest) via [releases on GitHub](https://github.com/itsallcode/openfasttrace/releases).

Check the chapter about [Installation](https://openfasttrace.itsallcode.org/user_guide/installation/installation.html) in the user guide for details.

Expand All @@ -100,14 +100,14 @@ java -jar product/target/openfasttrace-4.10.0.jar trace /path/to/directory/being

If you want to run OFT automatically as part of a continuous build, we recommend using our plugins for [Gradle](https://github.com/itsallcode/openfasttrace-gradle) and [Maven](https://github.com/itsallcode/openfasttrace-maven-plugin).

For more details about how to run OFT please consult the [user guide](https://openfasttrace.itsallcode.org/user_guide/user_guide.md).
For more details about how to run OFT please consult the [user guide](https://openfasttrace.itsallcode.org/user_guide/user_guide.html).

### Download and Execute in Continuous Integration

If you want to run OFT in a CI build, you can use the OFT wrapper script [oftw.sh](product/oftw.sh). The script only requires Java 17 and Maven and downloads the OFT JAR from Maven Central if it is not yet available in the local Maven repository `$HOME/.m2/repository`.

## Development

If you want to learn how to build OpenFastTrace, please check our [Developer Guide](https://openfasttrace.itsallcode.org/developer_guide/developer_guide.md).
If you want to learn how to build OpenFastTrace, please check our [Developer Guide](https://openfasttrace.itsallcode.org/developer_guide/developer_guide.html).

You would like to contribute to OFT? Please check out our [Contributor Guide](CONTRIBUTING.md) to get started.
2 changes: 1 addition & 1 deletion doc/developer_guide/plugin_developer_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This guide describes how to develop [plugins](../plugins.md) for OpenFastTrace (

## Initial Setup

1. Create a new Java project and add dependency [`org.itsallcode.openfasttrace:openfasttrace-api`](https://search.maven.org/artifact/org.itsallcode.openfasttrace/openfasttrace-api):
1. Create a new Java project and add dependency [`org.itsallcode.openfasttrace:openfasttrace-api`](https://repo1.maven.org/maven2/org/itsallcode/openfasttrace/openfasttrace-api/):
```xml
<dependency>
<groupId>org.itsallcode.openfasttrace</groupId>
Expand Down
4 changes: 2 additions & 2 deletions doc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ permalink: /
description: OpenFastTrace is a requirement tracing suite for Agile Development.
---

# <img src="assets/images/openfasttrace_logo.svg" alt="OFT logo" width="150"/> OpenFastTrace
# OpenFastTrace

## What is OpenFastTrace?

Expand All @@ -30,7 +30,7 @@ Below you see a screenshot of an HTML tracing report where OFT traces itself. Yo
## Project Information

* [💻 GitHub Repository](https://github.com/itsallcode/openfasttrace)
* [📦 Maven Central](https://search.maven.org/search?q=g:org.itsallcode.openfasttrace%20a:openfasttrace)
* [📦 Maven Central](https://repo1.maven.org/maven2/org/itsallcode/)
* [📽️ Introduction Video](https://www.youtube.com/watch?v=tlzMT6RaVWA)
* [🛗 Elevator Pitch](https://github.com/itsallcode/openfasttrace-demo/tree/main?tab=readme-ov-file#elevator-pitch)
* [📢 Blog](https://blog.itsallcode.org/)
Expand Down
Loading