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
124 changes: 124 additions & 0 deletions .github/workflows/codeboarding.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
name: CodeBoarding Action for RIDE

on:
workflow_dispatch:
inputs:
repository_url:
description: 'Repository URL to test with'
required: false
default: 'https://github.com/robotframework/RIDE'
type: string
source_branch:
description: 'Source branch for comparison'
required: false
default: 'master'
type: string
target_branch:
description: 'Target branch for comparison'
required: false
default: 'develop'
type: string
output_format:
description: 'Output format for documentation'
required: false
default: '.md'
type: string

pull_request:
branches: [ master, develop ]
types: [opened, synchronize, reopened]

schedule:
# Run daily at 2 AM UTC
- cron: '0 2 * * *'

jobs:
update-docs-action-usage:
runs-on: ubuntu-latest
permissions:
contents: write
pull-requests: write
timeout-minutes: 60

steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
token: ${{ secrets.GITHUB_TOKEN }}
fetch-depth: 0 # Required to access branch history

# Determine branches based on context
- name: Set branch variables
id: set-branches
run: |
if [ "${{ github.event_name }}" = "pull_request" ]; then
echo "source_branch=${{ github.head_ref }}" >> $GITHUB_OUTPUT
echo "target_branch=${{ github.base_ref }}" >> $GITHUB_OUTPUT
elif [ "${{ github.event.inputs.source_branch }}" != "" ] && [ "${{ github.event.inputs.target_branch }}" != "" ]; then
echo "source_branch=${{ github.event.inputs.source_branch }}" >> $GITHUB_OUTPUT
echo "target_branch=${{ github.event.inputs.target_branch }}" >> $GITHUB_OUTPUT
else
# Default to current branch and main
echo "source_branch=${{ github.ref_name }}" >> $GITHUB_OUTPUT
echo "target_branch=main" >> $GITHUB_OUTPUT
fi

- name: Fetch CodeBoarding Documentation
id: codeboarding
uses: ./
with:
repository_url: ${{ github.event.inputs.repository_url }}
source_branch: ${{ steps.set-branches.outputs.source_branch }}
target_branch: ${{ steps.set-branches.outputs.target_branch }}
output_directory: 'doc/.codeboarding'
output_format: ${{ github.event.inputs.output_format || '.md' }}

- name: Display Action Results
run: |
echo "Documentation files created: ${{ steps.codeboarding.outputs.markdown_files_created }}"
echo "JSON files created: ${{ steps.codeboarding.outputs.json_files_created }}"
echo "Documentation directory: ${{ steps.codeboarding.outputs.output_directory }}"
echo "JSON directory: ${{ steps.codeboarding.outputs.json_directory }}"
echo "Has changes: ${{ steps.codeboarding.outputs.has_changes }}"

# Check if we have any changes to commit
- name: Check for changes
id: git-changes
run: |
if [ -n "$(git status --porcelain)" ]; then
echo "has_git_changes=true" >> $GITHUB_OUTPUT
else
echo "has_git_changes=false" >> $GITHUB_OUTPUT
fi

- name: Create Pull Request
if: steps.git-changes.outputs.has_git_changes == 'true' && steps.codeboarding.outputs.has_changes == 'true'
uses: peter-evans/create-pull-request@v5
with:
token: ${{ secrets.GITHUB_TOKEN }}
commit-message: "docs: update codeboarding documentation"
title: "📚 CodeBoarding Documentation Update"
body: |
## 📚 Documentation Update

This PR contains updated documentation files fetched from the CodeBoarding service.

### 📊 Summary
- **Documentation files created/updated**: ${{ steps.codeboarding.outputs.markdown_files_created }}
- **JSON files created/updated**: ${{ steps.codeboarding.outputs.json_files_created }}
- **Documentation directory**: `${{ steps.codeboarding.outputs.output_directory }}/`
- **JSON directory**: `${{ steps.codeboarding.outputs.json_directory }}/`
- **Source branch**: `${{ steps.set-branches.outputs.source_branch }}`
- **Target branch**: `${{ steps.set-branches.outputs.target_branch }}`
- **Output format**: `${{ github.event.inputs.output_format || '.md' }}`
- **Repository analyzed**: `${{ steps.codeboarding.outputs.repo_url }}`

### 🔍 Changes
Files have been updated with fresh documentation content based on code changes between branches.

---

🤖 This PR was automatically generated by the CodeBoarding documentation update workflow.
branch: docs/codeboarding-update
base: ${{ steps.set-branches.outputs.target_branch }}
delete-branch: true
32 changes: 32 additions & 0 deletions .github/workflows/codeboarding_generate.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Generate Documentation
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
types: [opened, synchronize, reopened]

jobs:
documentation:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0 # Required to access branch history

- name: Generate Documentation
uses: codeboarding/codeboarding-ghaction@v1
with:
repository_url: ${{ github.server_url }}/${{ github.repository }}
source_branch: ${{ github.head_ref || github.ref_name }}
target_branch: ${{ github.base_ref || 'main' }}
output_directory: 'doc'
output_format: '.md'

- name: Upload Documentation
uses: actions/upload-artifact@v4
with:
name: documentation
path: |
doc/.codeboarding/
6 changes: 6 additions & 0 deletions CHANGELOG.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ The format is based on http://keepachangelog.com/en/1.0.0/[Keep a Changelog]
and this project adheres to http://semver.org/spec/v2.0.0.html[Semantic Versioning].

// == https://github.com/robotframework/RIDE[Unreleased]

== https://github.com/robotframework/RIDE/blob/master/doc/releasenotes/ride-2.1.5.1.rst[2.1.5.1] - 2025-07-26

=== Fixed
- Fix faulty cell editor in settings of Grid Editor which would prevent to change to Text Editor and Run tabs.

== https://github.com/robotframework/RIDE/blob/master/doc/releasenotes/ride-2.1.5.rst[2.1.5] - 2025-07-25

=== Added
Expand Down
10 changes: 5 additions & 5 deletions README.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -22,26 +22,26 @@ You can use the tag *robotframework-ide* to search and ask on https://stackoverf

== **Welcome to the development version of RIDE - next major release will be version 2.2**

If you are looking for the latest released version, you can get the source code from **https://github.com/robotframework/RIDE/releases[releases]** or from branch **https://github.com/robotframework/RIDE/tree/release/2.1.5[release/2.1.5]**
If you are looking for the latest released version, you can get the source code from **https://github.com/robotframework/RIDE/releases[releases]** or from branch **https://github.com/robotframework/RIDE/tree/release/2.1.5.1[release/2.1.5.1]**

See the https://github.com/robotframework/RIDE/blob/master/doc/releasenotes/ride-2.1.5.rst[release notes] for latest release version 2.1.5
See the https://github.com/robotframework/RIDE/blob/master/doc/releasenotes/ride-2.1.5.1.rst[release notes] for latest release version 2.1.5.1

**Version https://github.com/robotframework/RIDE/tree/release/2.0.8.1[2.0.8.1] was the last release supporting Python 3.6 and 3.7**

**Version https://github.com/robotframework/RIDE/tree/release/1.7.4.2[1.7.4.2] was the last release supporting Python 2.7**


**The current development version is based on 2.1.5, supports Python from 3.8 up to 3.14 (25th July 2025).**
**The current development version is based on 2.1.5.1, supports Python from 3.8 up to 3.14 (26th July 2025).**

Currently, the unit tests are tested on Python 3.10, 3.11 and 3.13 (3.13 is the recommended version).
We now have an experimental workflow on Fedora Linux 41, with wxPython 4.2.3 and Python 3.14.b2.
Likewise, the current version of wxPython, is 4.2.3, but RIDE is known to work with 4.0.7, 4.1.1 and 4.2.2 versions.

(3.8 <= python <= 3.14) Install current released version (*2.1.5*) with:
(3.8 <= python <= 3.14) Install current released version (*2.1.5.1*) with:

`pip install -U robotframework-ride`

(3.8 <= python <= 3.14) Install current development version (**2.1.5**) with:
(3.8 <= python <= 3.14) Install current development version (**2.1.5.1**) with:

`pip install -U https://github.com/robotframework/RIDE/archive/develop.zip`

Expand Down
13 changes: 5 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,26 +21,26 @@ You can use the tag *robotframework-ide* to search and ask on [StackOverflow](ht

## **Welcome to RIDE - next major release will be version 2.2**

If you are looking for the latest released version, you can get the source code from **[releases](https://github.com/robotframework/RIDE/releases)** or from branch **[release/2.1.4.1](https://github.com/robotframework/RIDE/tree/release/2.1.4.1)**
If you are looking for the latest released version, you can get the source code from **[releases](https://github.com/robotframework/RIDE/releases)** or from branch **[release/2.1.5.1](https://github.com/robotframework/RIDE/tree/release/2.1.5.1)**

See the [release notes](https://github.com/robotframework/RIDE/blob/master/doc/releasenotes/ride-2.1.4.1.rst) for latest release version 2.1.4.1
See the [release notes](https://github.com/robotframework/RIDE/blob/master/doc/releasenotes/ride-2.1.5.1.rst) for latest release version 2.1.5.1

**Version [2.0.8.1](https://github.com/robotframework/RIDE/tree/release/2.0.8.1) was the last release supporting Python 3.6 and 3.7**

**Version [1.7.4.2](https://github.com/robotframework/RIDE/tree/release/1.7.4.2) was the last release supporting Python 2.7**


**The current development version is based on 2.1.4.1, supports Python from 3.8 up to 3.14 (24th June 2025).**
**The current development version is based on 2.1.5.1, supports Python from 3.8 up to 3.14 (26th July 2025).**

Currently, the unit tests are tested on Python 3.10, 3.11 and 3.13 (3.13 is the recommended version).
We now have an experimental workflow on Fedora Linux 41, with wxPython 4.2.3 and Python 3.14.b2.
Likewise, the current version of wxPython, is 4.2.3, but RIDE is known to work with 4.0.7, 4.1.1 and 4.2.2 versions.

(3.8 <= python <= 3.14) Install current released version (*2.1.4*) with:
(3.8 <= python <= 3.14) Install current released version (*2.1.5.1*) with:

`pip install -U robotframework-ride`

(3.8 <= python <= 3.14) Install current development version (**2.2dev32**) with:
(3.8 <= python <= 3.14) Install current development version with:

`pip install -U https://github.com/robotframework/RIDE/archive/develop.zip`

Expand Down Expand Up @@ -69,6 +69,3 @@ Quality Gate Status: [[!Sonar](https://sonarcloud.io/api/project_badges/measure?

---

## Stargazers over time

[[!Stargazers over time](https://starchart.cc/robotframework/RIDE.svg)]
Loading
Loading