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
4 changes: 2 additions & 2 deletions .github/agents/technical-writer.agent.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ docs/
justifications.md # Generated by ReqStream
requirements_report/
trace_matrix.md # Generated by ReqStream
build_notes.md # Generated by BuildMark
build_notes/
build_notes.md # Generated by BuildMark
versions.md # Generated by VersionMark
code_quality/
sonar-quality.md # Generated by SonarMark
Expand Down Expand Up @@ -100,7 +100,7 @@ docs/
- **❌ Avoid**: Tool version numbers, specific counts (requirements, tests, files), current dates, "latest" references
- **❌ Examples**: "Currently using Node.js 18.2.1", "The system has 47 requirements", "As of March 2024"
- **✅ Instead**: Reference auto-generated reports, use relative descriptions, focus on stable concepts
- **✅ Examples**: "See build_notes.md for current tool versions", "The requirements are organized by subsystem",
- **✅ Examples**: "See docs/build_notes.md for current tool versions", "The requirements are organized by subsystem",
"The architecture follows..."

**Exception**: Include transitory information only when documenting specific releases, version history, or
Expand Down
7 changes: 1 addition & 6 deletions .github/workflows/release.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -63,18 +63,13 @@ jobs:
name: documents
path: artifacts

- name: Move build_notes.md to root
run: |
set -e
mv artifacts/build_notes.md build_notes.md

- name: Create GitHub Release
if: inputs.publish == 'release' || inputs.publish == 'publish'
uses: ncipollo/release-action@v1
with:
tag: ${{ inputs.version }}
artifacts: artifacts/*
bodyFile: build_notes.md
bodyFile: artifacts/build_notes.md
generateReleaseNotes: false

- name: Publish to NuGet.org
Expand Down
Loading