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
2 changes: 1 addition & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -683,7 +683,7 @@ workflows:
# - release/2023-04-17, release/2023-04-17.123 (date-based)
# - hotfix/123.456.789, hotfix/123.456.789-rc.1213 (per https://semver.org/)
# - hotfix/2023-04-17, hotfix/2023-04-17.123 (date-based)
only: /^(production|main|master|develop)$|^project\/[a-zA-z0-9\-\.]+|^(feature|bugfix)\/[a-zA-Z0-9\-\.\,_]+$|^ci.*|^(release|hotfix)\/[0-9]+(\.[0-9]+){2}(-rc\.[0-9]+)?$|^(release|hotfix)\/[0-9]{4}-[0-9]{2}-[0-9]{2}(\.[0-9]+)?$/
only: /^(production|main|master|develop|1.x|2.x)$|^project\/[a-zA-z0-9\-\.]+|^(feature|bugfix)\/[a-zA-Z0-9\-\.\,_]+$|^ci.*|^(release|hotfix)\/[0-9]+(\.[0-9]+){2}(-rc\.[0-9]+)?$|^(release|hotfix)\/[0-9]{4}-[0-9]{2}-[0-9]{2}(\.[0-9]+)?$/
tags:
ignore: /.*/
- deploy-tags:
Expand Down
8 changes: 8 additions & 0 deletions .github/workflows/build-test-deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ on:
- main
- master
- develop
#;< VORTEX_DEV
- 1.x
- 2.x
#;> VORTEX_DEV
- release/**
- hotfix/**
- project/**
Expand All @@ -32,6 +36,10 @@ on:
- main
- master
- develop
#;< VORTEX_DEV
- 1.x
- 2.x
#;> VORTEX_DEV
- release/**
- hotfix/**
- project/**
Expand Down
4 changes: 4 additions & 0 deletions .github/workflows/draft-release-notes.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ on:
- '*'
branches:
- develop
#;< VORTEX_DEV
- 1.x
- 2.x
#;> VORTEX_DEV

permissions:
contents: write
Expand Down
4 changes: 4 additions & 0 deletions .github/workflows/vortex-test-common.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,13 @@ on:
push:
branches:
- develop
- 1.x
- 2.x
pull_request:
branches:
- develop
- 1.x
- 2.x
- 'feature/**'
- 'bugfix/**'

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/vortex-test-docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ jobs:
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
publish-dir: '.vortex/docs/build'
production-branch: develop
production-branch: 1.x
deploy-message: "Deploy from GitHub Actions"
enable-pull-request-comment: true
enable-commit-comment: true
Expand Down
4 changes: 4 additions & 0 deletions .github/workflows/vortex-test-installer.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,13 @@ on:
push:
branches:
- develop
- 1.x
- 2.x
pull_request:
branches:
- develop
- 1.x
- 2.x
- 'feature/**'
- 'bugfix/**'

Expand Down
2 changes: 1 addition & 1 deletion .vortex/docs/content/README.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ Refer to [Contributing](contributing) for more details.
## ⚖️ License

**Vortex** is licensed under the [GPL-3.0](https://www.gnu.org/licenses/gpl-3.0.en.html) license. See
the [LICENSE](https://github.com/drevops/vortex/blob/develop/LICENSE) file for more details.
the [LICENSE](https://github.com/drevops/vortex/blob/1.x/LICENSE) file for more details.
Comment thread
AlexSkrypnyk marked this conversation as resolved.

:::tip

Expand Down
4 changes: 2 additions & 2 deletions .vortex/docs/content/continuous-integration/circleci.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Before you begin, ensure you have:

[Log in to CircleCI](https://app.circleci.com/) and add your repository as a new
project. CircleCI will connect to your GitHub account, detect the
[`.circleci/config.yml`](https://github.com/drevops/vortex/blob/develop/.circleci/config.yml)
[`.circleci/config.yml`](https://github.com/drevops/vortex/blob/1.x/.circleci/config.yml)
Comment thread
coderabbitai[bot] marked this conversation as resolved.
configuration file, and start running builds automatically when you push code.

### 2. Add SSH key for database download
Expand Down Expand Up @@ -84,7 +84,7 @@ same provider, you can use a single key for both operations.

CircleCI uses SSH key fingerprints to load the correct keys into the runner
container. Update the YAML anchors in your
[`.circleci/config.yml`](https://github.com/drevops/vortex/blob/develop/.circleci/config.yml)
[`.circleci/config.yml`](https://github.com/drevops/vortex/blob/1.x/.circleci/config.yml)
file:

- `db_ssh_fingerprint` - your database download SSH key fingerprint
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Before you begin, ensure you have:

GitHub Actions is enabled by default. Navigate to the **Actions** tab in your
repository to verify the workflow is detected. Vortex provides the workflow file
at [`.github/workflows/build-test-deploy.yml`](https://github.com/drevops/vortex/blob/develop/.github/workflows/build-test-deploy.yml).
at [`.github/workflows/build-test-deploy.yml`](https://github.com/drevops/vortex/blob/1.x/.github/workflows/build-test-deploy.yml).

No additional setup is required to enable the workflow.

Expand Down
2 changes: 1 addition & 1 deletion .vortex/docs/content/contributing/code-of-conduct.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ sidebar_position: 3
# Code of conduct

Please note that this project is released with
a [Contributor Code of Conduct](https://github.com/drevops/vortex/blob/develop/CODE_OF_CONDUCT.md). By participating in this
a [Contributor Code of Conduct](https://github.com/drevops/vortex/blob/1.x/CODE_OF_CONDUCT.md). By participating in this
project you agree to abide by its terms.
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ There are 2 types of the documentation that **Vortex** provides:
## www.vortextemplate.com

The Documentation (this site) is written in Markdown and located in
[`.vortex/docs`](https://github.com/drevops/vortex/blob/develop/.vortex/docs) directory. This is
[`.vortex/docs`](https://github.com/drevops/vortex/blob/1.x/.vortex/docs) directory. This is
Comment thread
coderabbitai[bot] marked this conversation as resolved.
removed when you install **Vortex** for a
consumer site.

Expand Down Expand Up @@ -54,7 +54,7 @@ An automated continuous integration build publishes this documentation.
## Consumer site documentation

**Vortex** provides a scaffold of the consumer site documentation in the
[`docs`](https://github.com/drevops/vortex/blob/develop/docs) directory.
[`docs`](https://github.com/drevops/vortex/blob/1.x/docs) directory.

After **Vortex** is installed into the consumer site, these docs are
intended to be used by the site maintainers and stay up-to-date with the
Expand Down
66 changes: 64 additions & 2 deletions .vortex/docs/content/contributing/maintenance/release.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,68 @@
# Release

Follow the steps below to release a new version of **Vortex**:
## Versioning Strategy

Vortex uses **SemVer+CalVer** format for releases: `MAJOR.MINOR.PATCH-YYYY.MM.0`

### Semantic Version (MAJOR.MINOR.PATCH)

- **MAJOR**: Breaking changes that require migration or significant updates
- **MINOR**: New features, backward compatible

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

Add hyphens to compound adjectives.

Per static analysis, compound adjectives modifying nouns should use hyphens. Update all occurrences of "backward compatible" to "backward-compatible" on lines 10, 37, and 42.

Apply this diff:

-- **MINOR**: New features, backward compatible
+- **MINOR**: New features, backward-compatible
-2. **Bump MINOR** when adding functionality in a backward compatible manner:
+2. **Bump MINOR** when adding functionality in a backward-compatible manner:
-3. **Bump PATCH** when making backward compatible bug fixes:
+3. **Bump PATCH** when making backward-compatible bug fixes:

Also applies to: 37-37, 42-42

🧰 Tools
🪛 LanguageTool

[uncategorized] ~10-~10: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...cant updates - MINOR: New features, backward compatible - PATCH: Bug fixes, backward compat...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

🤖 Prompt for AI Agents
.vortex/docs/content/contributing/maintenance/release.mdx lines 10, 37, 42:
Static analysis requires hyphens in compound adjectives; replace each occurrence
of "backward compatible" with "backward-compatible" on the listed lines. Edit
those three lines to insert the hyphen so the phrases read "backward-compatible"
while preserving surrounding punctuation and capitalization.

- **PATCH**: Bug fixes, backward compatible

### Calendar Version (`YYYY.MM.0`)

- Reflects the release date
- Helps track release timeline
- Always ends with `.0`
- `YY` - Short year - `6`, `16`, `106`
- `MM` - Short month - `1`, `2` ... `11`, `12`
Comment thread
AlexSkrypnyk marked this conversation as resolved.

### Version Examples

- `1.0.0-2025.11.0` - First major release, November 2025
- `1.1.0-2025.12.0` - New features added, December 2025
- `1.1.1-2025.12.0` - Bug fix release, same month
- `2.0.0-2026.1.0` - Breaking changes, January 2026

### Version Numbering Guidelines

When creating a new release, determine the version based on the changes:

1. **Bump MAJOR** when making incompatible breaking changes:
- Removing features or configuration options
- Changing default behavior that breaks existing workflows
- Updating to new major versions of core dependencies (e.g., Drupal 11)

2. **Bump MINOR** when adding functionality in a backward compatible manner:
- Adding new optional features
- Adding new scripts or commands
- Enhancing existing features without breaking changes

3. **Bump PATCH** when making backward compatible bug fixes:
- Fixing bugs or errors
- Security patches
- Documentation updates
- Minor improvements that don't change functionality

4. **Set CalVer** to the release date in `YYYY.MM.0` format:
- Always use the year and month of the release
- Always end with `.0`

### Branch Strategy

- `1.x` - Current stable release branch
- `2.x` - Development branch for 2.x releases (future)

:::note
Vortex uses **GitHub Flow** with version branches (`1.x`, `2.x`) instead of GitFlow.
The `develop` branch is deprecated for Vortex development.
Consumer projects created from Vortex continue to use GitFlow with `develop`.
:::

## Release Process

Follow the steps below to release a new version of the Vortex:

1. Run renovate bot locally to update all dependencies outside of the schedule:
```
Expand All @@ -13,6 +75,6 @@ renovate --schedule= --force-cli=true drevops/vortex
6. Increment minor version of all packages in `composer.json`. Run `composer update -W && composer bump`.
7. Update minor version of dependencies in theme's `package.json`.
8. Increment the cache version in `.circleci/config.yml` and `.github/workflows/build-test-deploy.yml`.
9. Update documentation with `cd .vortex && ahoy update-docs`.
9. Updated documentation with `cd .vortex && ahoy update-docs`.
Comment thread
coderabbitai[bot] marked this conversation as resolved.
10. Update installer video with `cd .vortex && ahoy update-installer-video`.
11. Create new release notes using [release template](./release_template.md).
4 changes: 2 additions & 2 deletions .vortex/docs/content/drupal/module-scaffold.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 5

# Module scaffold

[Module scaffold](https://github.com/drevops/vortex/tree/develop/web/modules/custom/ys_base)
[Module scaffold](https://github.com/drevops/vortex/tree/1.x/web/modules/custom/ys_base)
is an example of a Drupal module.

We recommend creating a custom `ys_base` module for your project to hold
Expand All @@ -24,7 +24,7 @@ machine name for a theme name.

## Deploy file

The [`ys_base.deploy.php`](https://github.com/drevops/vortex/blob/develop/web/modules/custom/ys_base/ys_base.deploy.php)
The [`ys_base.deploy.php`](https://github.com/drevops/vortex/blob/1.x/web/modules/custom/ys_base/ys_base.deploy.php)
file is an example of a Drush deploy file that can be used
to run deployment commands during the site [provisioning](provision) process.

Expand Down
2 changes: 1 addition & 1 deletion .vortex/docs/content/drupal/provision.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_position: 3
# Provision

The provisioning process, handled by the
[`provision.sh`](https://github.com/drevops/vortex/blob/develop/scripts/vortex/provision.sh)
[`provision.sh`](https://github.com/drevops/vortex/blob/1.x/scripts/vortex/provision.sh)
script, sets up a
Drupal site on already assembled codebase by either importing an existing
database from the dump or installing a fresh instance of Drupal using a profile,
Expand Down
12 changes: 6 additions & 6 deletions .vortex/docs/content/drupal/settings.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ environment-specific behavior — is controlled through the `settings.php` and
extends these files to support consistent setup across environments.

**Vortex** ships with its own streamlined version of
the [`settings.php`](https://github.com/drevops/vortex/blob/develop/web/sites/default/settings.php) and
[`services.yml`](https://github.com/drevops/vortex/blob/develop/web/sites/default/services.yml) files.
the [`settings.php`](https://github.com/drevops/vortex/blob/1.x/web/sites/default/settings.php) and
[`services.yml`](https://github.com/drevops/vortex/blob/1.x/web/sites/default/services.yml) files.
Comment thread
AlexSkrypnyk marked this conversation as resolved.

It provides logic to detect the current environment (such as local, CI, or
production) and apply settings conditionally. You can also define configuration
overrides for individual modules if needed.

The default **Drupal Scaffold**'s [`default.settings.php`](https://github.com/drevops/vortex/blob/develop/web/sites/default/default.settings.php)
and [`default.services.yml`](https://github.com/drevops/vortex/blob/develop/web/sites/default/default.services.yml)
The default **Drupal Scaffold**'s [`default.settings.php`](https://github.com/drevops/vortex/blob/1.x/web/sites/default/default.settings.php)
and [`default.services.yml`](https://github.com/drevops/vortex/blob/1.x/web/sites/default/default.services.yml)
files are also provided if you choose to use them instead.

## Approach
Expand Down Expand Up @@ -98,7 +98,7 @@ import EnvironmentIndicatorModuleSettingsExample from '!!raw-loader!./../../../.

## Settings file structure

The [`settings.php`](https://github.com/drevops/vortex/blob/develop/web/sites/default/settings.php)
The [`settings.php`](https://github.com/drevops/vortex/blob/1.x/web/sites/default/settings.php)
file is organized into the following sections:

- [Database](#database)
Expand Down Expand Up @@ -282,7 +282,7 @@ import LocalServicesExample from '!!raw-loader!./../../../../web/sites/default/e

## Testing settings with unit tests

**Vortex** includes a [set of unit tests](https://github.com/drevops/vortex/blob/develop/tests/phpunit/Drupal)
**Vortex** includes a [set of unit tests](https://github.com/drevops/vortex/blob/1.x/tests/phpunit/Drupal)
to verify that settings are applied correctly for each detected environment
type.

Expand Down
2 changes: 1 addition & 1 deletion .vortex/docs/content/drupal/theme-scaffold.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 6

# Theme scaffold

[Theme scaffold](https://github.com/drevops/vortex/tree/develop/web/themes/custom/your_site_theme)
[Theme scaffold](https://github.com/drevops/vortex/tree/1.x/web/themes/custom/your_site_theme)
is an example of a Drupal theme.

We recommend creating a custom `your_site_theme` theme for your project to place
Expand Down
14 changes: 7 additions & 7 deletions .vortex/docs/content/features.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,16 +29,16 @@ import {

### Settings and environment detection

- Pre-configured [general settings](https://github.com/drevops/vortex/blob/develop/web/sites/default/settings.php)
- Pre-configured [general settings](https://github.com/drevops/vortex/blob/1.x/web/sites/default/settings.php)
- Environment type detection based on the hosting provider
- Optimised per-module settings for quick start
- Multi-database configuration for MySQL and MariaDB

### Module & theme scaffolds

- [Custom module scaffold](https://github.com/drevops/vortex/blob/develop/web/modules/custom/ys_base)
- [Custom theme scaffold](https://github.com/drevops/vortex/blob/develop/web/themes/custom/your_site_theme)
- [Tests scaffold](https://github.com/drevops/vortex/blob/develop/web/modules/custom/ys_base/tests)
- [Custom module scaffold](https://github.com/drevops/vortex/blob/1.x/web/modules/custom/ys_base)
- [Custom theme scaffold](https://github.com/drevops/vortex/blob/1.x/web/themes/custom/your_site_theme)
- [Tests scaffold](https://github.com/drevops/vortex/blob/1.x/web/modules/custom/ys_base/tests)

### Admin modules

Expand Down Expand Up @@ -198,7 +198,7 @@ import {

### Development workflow automation

- [Pull request template](https://github.com/drevops/vortex/blob/develop/.github/PULL_REQUEST_TEMPLATE.md) for consistent reviews
- [Pull request template](https://github.com/drevops/vortex/blob/1.x/.github/PULL_REQUEST_TEMPLATE.md) for consistent reviews
- [Release drafter](https://github.com/release-drafter/release-drafter) for automated changelog
- [PR auto-assign](https://github.com/toshimaru/auto-author-assign) for review assignments
- [PR auto-label](https://github.com/eps1lon/actions-label-merge-conflict) for merge conflicts
Expand All @@ -210,8 +210,8 @@ import {

### Project Documentation

- Customized [README.md](https://github.com/drevops/vortex/blob/develop/README.dist.md) for easy onboarding
- [Scaffold for project-specific documentation](https://github.com/drevops/vortex/blob/develop/docs) for easy documentation management
- Customized [README.md](https://github.com/drevops/vortex/blob/1.x/README.dist.md) for easy onboarding
- [Scaffold for project-specific documentation](https://github.com/drevops/vortex/blob/1.x/docs) for easy documentation management

### Vortex Documentation

Expand Down
6 changes: 3 additions & 3 deletions .vortex/docs/content/hosting/acquia.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,14 +36,14 @@ When code is deployed, Vortex automatically:
3. **Sends notifications** - Notifies configured channels about the deployment

This is implemented using [Acquia Cloud Hooks](https://docs.acquia.com/cloud-platform/develop/api/cloud-hooks/) -
pre-configured scripts in the [`hooks/`](https://github.com/drevops/vortex/tree/develop/hooks)
pre-configured scripts in the [`hooks/`](https://github.com/drevops/vortex/tree/1.x/hooks)

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Check if 1.x branch exists locally or remotely
git branch -a 2>/dev/null | grep -E '1\.x|origin/1\.x'

Repository: drevops/vortex

Length of output: 40


Critical: Documentation links reference non-existent 1.x branch.

The three documentation links at lines 39, 46, and 60 point to the 1.x branch, which does not exist in the repository. Merging this change will create broken links that resolve to 404 errors.

Before merging, either:

  1. Create the 1.x branch as part of this PR or in preparation, or
  2. Revert these links to develop if the documentation should apply to the development version.

Also applies to: 46-46, 60-60

🤖 Prompt for AI Agents
.vortex/docs/content/hosting/acquia.mdx around lines 39, 46 and 60: the
documentation links point to a non-existent `1.x` branch causing 404s; update
each URL to reference the correct existing branch (`develop`) or another valid
branch used by repo; specifically replace `tree/1.x` with `tree/develop` in the
links on lines 39, 46 and 60 (or create the `1.x` branch in the repo if those
links must remain unchanged).

directory that trigger on code deployments, code updates, and database copy
operations.

### Environment detection

Vortex automatically detects when running on Acquia and loads appropriate
settings from [`web/sites/default/includes/providers/settings.acquia.php`](https://github.com/drevops/vortex/blob/develop/web/sites/default/includes/providers/settings.acquia.php).
settings from [`web/sites/default/includes/providers/settings.acquia.php`](https://github.com/drevops/vortex/blob/1.x/web/sites/default/includes/providers/settings.acquia.php).
This includes Acquia-specific configurations for caching, file paths, and
environment variables.

Expand All @@ -57,7 +57,7 @@ Before you begin, ensure you have:

### 1. Configure environment variables

Add the following variables to your [`.env`](https://github.com/drevops/vortex/blob/develop/.env)
Add the following variables to your [`.env`](https://github.com/drevops/vortex/blob/1.x/.env)
file:

| Variable | Description |
Expand Down
6 changes: 3 additions & 3 deletions .vortex/docs/content/hosting/lagoon.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,14 +34,14 @@ When code is deployed, Vortex automatically:
2. **Sends notifications** - Notifies configured channels about the deployment

This is implemented using post-rollout tasks defined in the
[`.lagoon.yml`](https://github.com/drevops/vortex/blob/develop/.lagoon.yml)
[`.lagoon.yml`](https://github.com/drevops/vortex/blob/1.x/.lagoon.yml)
Comment thread
AlexSkrypnyk marked this conversation as resolved.
configuration file, which also defines Docker image mappings and
environment-specific configurations.

### Environment detection

Vortex automatically detects when running on Lagoon and loads appropriate
settings from [`web/sites/default/includes/providers/settings.lagoon.php`](https://github.com/drevops/vortex/blob/develop/web/sites/default/includes/providers/settings.lagoon.php).
settings from [`web/sites/default/includes/providers/settings.lagoon.php`](https://github.com/drevops/vortex/blob/1.x/web/sites/default/includes/providers/settings.lagoon.php).
This includes Lagoon-specific configurations for caching, file paths, and
environment variables provided by the platform.

Expand All @@ -56,7 +56,7 @@ Before you begin, ensure you have:

### 1. Configure environment variables

Add the following variables to your [`.env`](https://github.com/drevops/vortex/blob/develop/.env)
Add the following variables to your [`.env`](https://github.com/drevops/vortex/blob/1.x/.env)
file:

| Variable | Description |
Expand Down
Loading