Skip to content

types: add optional release sequence field #82

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
alisawavezen12 wants to merge 2 commits into from
Closed

types: add optional release sequence field #82

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5f37090
Add release sequence to database types
alisawavezen12 Sep 10, 2026
c56f122
Lint and build
github-actions[bot] Sep 10, 2026
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
5 changes: 5 additions & 0 deletions build/src/dbScheme/release.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,11 @@ export interface ReleaseDBScheme {
* @example Version 1.0
*/
release: string;
/**
* Optional sequence for new releases, assigned from 1 within a project.

@neSpecc neSpecc Sep 11, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

explain what is "release sequence" and why it is used

@alisawavezen12 alisawavezen12 Sep 12, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

releaseSequence is a number for each project. It shows the order in which new releases were first saved in Hawk.

The release validator will use it to find the previous release and compare events between releases. We cannot use the release name or the RabbitMQ message order because release names can be arbitrary, and messages can arrive late or more than once.

The field is optional because old releases were created before this feature and do not have this value. For now, the number shows the order in which Hawk first received the releases, not the exact deployment order.

* Legacy releases created before this feature may not have this field.
*/
releaseSequence?: number;
/**
* Commit data, to identify suspicious ones
*/
Expand Down
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@hawk.so/types",
"version": "0.7.0",
"version": "0.7.1",
"description": "TypeScript definitions for Hawk",
"types": "build/index.d.ts",
"main": "build/index.js",
Expand Down
6 changes: 6 additions & 0 deletions src/dbScheme/release.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,12 @@ export interface ReleaseDBScheme {
*/
release: string;

/**
* Optional sequence for new releases, assigned from 1 within a project.
* Legacy releases created before this feature may not have this field.
*/
releaseSequence?: number;

/**
* Commit data, to identify suspicious ones
*/
Expand Down