crashappsec / crashappsec/chalk
FYI: CHANGELOG.md is published publicly on crashoverride.com — internal code name "crayon" currently exposed
- Dominant language
- Nim
- Stars
- 436
- Forks
- 25
- PR merge metrics
- No merged PRs in 30d
Description
Heads-up rather than a bug report: **`CHANGELOG.md` in this repo is published verbatim on the public marketing site**, and it currently contains an internal code name.
No action needed on the existing line. Filing this so the exposure path is known when writing future entries.
## What's exposed
`CHANGELOG.md` line 410:
> It allows a trusted system daemon like `crayon` to inject useful metadata into the artifact which otherwise cha…
`crayon` is the internal code name for **Crash Override Endpoint**. Per the GTM voice guide it is not supposed to appear in external material; the public name is "Crash Override Endpoint".
## How it reaches the public
`crashappsec/digital-marketing` fetches this file at build time and renders it as a docs page:
- `packages/marketing/scripts/sync-chalk-changelog.ts` pulls the public `CHANGELOG.md` on **every deploy**, as a prebuild step
- Output is written to `src/content/docs/chalk/changelog.md`, which is **gitignored** and not committed
- It renders at **https://crashoverride.com/docs/chalk/changelog**
Live and publicly reachable today.
Because the sync runs on every deploy and the generated file is gitignored, this cannot be fixed downstream. Editing it in the marketing repo is overwritten on the next build. Anything in this file is effectively published.
## The actual ask
Not a request to rewrite line 410. It is release-note history and the cost of leaving it is low.
The useful takeaway is forward-looking: **`CHANGELOG.md` is a public marketing surface, not just a developer file.** Internal code names (`crayon` and anything similar) will end up on crashoverride.com if they land here. Worth knowing when writing future entries.
If someone does want to clean up line 410, changing `crayon` to `Crash Override Endpoint` is sufficient and would propagate on the next marketing deploy with no coordination needed.
## Context
Found during a site-wide content audit of crashoverride.com: crashappsec/digital-marketing#2156 (the marketing-side issue, where this is recorded as out of scope for exactly the reason above).
Contributor guide
No contributing guide indexed for this repository
Research direction
Read CHANGELOG.md around line 410 and inspect how packages/marketing/scripts/sync-chalk-changelog.ts publishes it to src/content/docs/chalk/changelog.md. The issue records the exposure path and says no immediate change is required; completion would require a separately defined documentation or release-note policy change.
Written by the indexing model from the issue text.
Assessment
- Domain
- content, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100