Skip to content

Commit

Permalink
Deprecate executable run methods and disable pipeline
Browse files Browse the repository at this point in the history
- Deprecated running the application via executables and warned users of potential issues.
- Updated the README to strongly recommend using alternative methods for running the application.
- Modified the pipeline to no longer build or create executables.
  • Loading branch information
FarzamMohammadi committed May 16, 2024
1 parent 30b7511 commit 4261944
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 14 deletions.
12 changes: 1 addition & 11 deletions .github/workflows/executables.yaml
Original file line number Diff line number Diff line change
@@ -1,17 +1,7 @@
name: Create executables

# Only trigger, when the release workflow succeeded
on:
workflow_run:
paths-ignore:
- 'ado_express/tests/**'
- '**/README.md'
- '.vscode/**'
- 'ado_express_api/**' # Not needed while developing app & api
- 'ado_express_app/**' # Not needed while developing app & api
workflows: ["Create a new release & tag commit"]
types:
- completed
on: {}

jobs:

Expand Down
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Welcome to the ADO Express codebase, your new go-to tool for release management.

You have two options to get started:

1. **CLI Tools & Executables**: Get tasks done efficiently using either CLI tools or our plug-and-play executables. The CLI requires either Docker or Python, while executables are a hassle-free option requiring no preliminary installations—ideal for getting started right away. For more on CLI, see [CLI Usage](#%EF%B8%8F-cli-usage), and for executables, check out [Executables](#executables).
1. **CLI**: Get tasks done efficiently using the CLI. The CLI requires either Docker or Python. For more on CLI, see [CLI Usage](#%EF%B8%8F-cli-usage).

2. **Web Application**: For those who prefer a more graphical approach with an intuitive user interface, you can opt for the full web application. For this option, proceed to [Web Application Usage](#%EF%B8%8F-web-application-usage).

Expand All @@ -23,7 +23,7 @@ Run various tasks through the CLI with minimal setup. You can either use Docker
- [Command-Line Argument Order](#command-line-argument-order)
1. [Docker Deployment](#docker-deployment)
2. [Docker Development Container](#docker-development-container)
3. [Executables](#executables)
3. [Executables (Deprecated)](#executables)
4. [Additional CLI Options](#additional-cli-options-deprecated) (Deprecated)

## Environment Variables & Command Line Arguments
Expand Down Expand Up @@ -123,7 +123,9 @@ Run various tasks through the CLI with minimal setup. You can either use Docker
> For more details on run configurations, refer to the [Environment Variables & Command Line Arguments](#environment-variables--command-line-arguments) section.
## Executables
## Executables (Deprecated)
**Warning**: The executables are deprecated and may not function as expected. All features may not work properly. We strongly suggest using other methods for running the application.
Download the executables from the [GitHub Releases](https://github.com/FarzamMohammadi/ado-express/releases) page. Opt for the [latest](https://github.com/FarzamMohammadi/ado-express/releases/tag/1.36.0) to stay up-to-date with the newest features.
Expand Down

0 comments on commit 4261944

Please sign in to comment.