diff --git a/README.md b/README.md index 6f4c607..7059930 100644 --- a/README.md +++ b/README.md @@ -143,7 +143,7 @@ OpenCite validates metadata at multiple stages: ## Metadata Rules -- Version values should match your planned GitHub release tag. +- Version values should match your planned GitHub release tag, except for an optional leading `v`. - Grant IDs must use `::`. - Publication date should be a real `YYYY-MM-DD` date. - ORCID values are validated when provided. @@ -157,7 +157,7 @@ OpenCite follows [Semantic Versioning](https://semver.org/) (`MAJOR.MINOR.PATCH` - `MINOR`: backward-compatible features - `PATCH`: backward-compatible bug fixes -Use the exact version/tag string you intend to publish for your GitHub release. +Enter the exact GitHub tag separately when it differs from the metadata version. ## Release Workflow @@ -172,7 +172,9 @@ When preparing a release: 4. Update `.zenodo.json` metadata when applicable. 5. Verify release metadata is consistent across GitHub, `CITATION.cff`, and `.zenodo.json`. -OpenCite automatically includes GitHub release and source-tree identifiers in `CITATION.cff` when a version and repository URL are present. +OpenCite includes the GitHub release URL in `CITATION.cff` when a version and repository URL are present. The release tag defaults to `v` plus the version, and can be edited to match the exact GitHub tag. If the tag and version differ (ignoring a leading `v`), the form displays a warning; the citation keeps the version and uses the tag for GitHub release links. A commit URL (`/commit/`) is included when a valid release commit hash is available, with an `# Update on release` reminder. GitHub import fills in the exact tag and hash when the latest release tag matches the version. + +Changing the version updates the default tag and clears the commit hash; a manually edited tag is preserved and checked against the new version. Changing the repository resets the tag to the version-based default and clears the hash. Changing the tag clears the hash. ## Grants Autofill diff --git a/src/App.jsx b/src/App.jsx index 992b93b..7cb9030 100644 --- a/src/App.jsx +++ b/src/App.jsx @@ -2,6 +2,8 @@ import { useEffect, useMemo, useRef, useState } from 'react'; import JSZip from 'jszip'; import { MetadataForm } from './components/MetadataForm.jsx'; import { normalizeMetadata } from './metadata/normalizeMetadata.js'; +import { getDefaultReleaseTag } from './metadata/releaseTag.js'; +import { updateMetadataField } from './metadata/updateMetadataField.js'; import { importGithubMetadata } from './services/githubImporter.js'; import { pickPreferredOrcidCandidate, searchOrcidCandidates } from './services/orcidSearch.js'; import { toCitationCff } from './services/citation.js'; @@ -34,6 +36,8 @@ const initialForm = { version: '0.1.0', publicationDate: '', repositoryCode: '', + releaseTag: 'v0.1.0', + releaseCommit: '', doi: '', abstract: '', references: '', @@ -316,6 +320,8 @@ function metadataToForm(metadata) { version: String(metadata.version ?? ''), publicationDate: String(metadata.publicationDate ?? ''), repositoryCode: String(metadata.repositoryCode ?? ''), + releaseTag: String(metadata.releaseTag ?? '') || getDefaultReleaseTag(metadata.version), + releaseCommit: String(metadata.releaseCommit ?? ''), doi: String(metadata.doi ?? ''), abstract: String(metadata.abstract ?? ''), references: Array.isArray(metadata.references) ? metadata.references.join('\n') : '', @@ -556,7 +562,7 @@ export default function App() { function updateField(event) { const { name, value } = event.target; setTouchedFields((current) => ({ ...current, [name]: true })); - setForm((current) => ({ ...current, [name]: value })); + setForm((current) => updateMetadataField(current, name, value)); } function appendGrantSuggestion(grantId) { diff --git a/src/components/MetadataForm.jsx b/src/components/MetadataForm.jsx index 84eaf3c..d4a7ef9 100644 --- a/src/components/MetadataForm.jsx +++ b/src/components/MetadataForm.jsx @@ -1,4 +1,5 @@ import { useState } from 'react'; +import { releaseTagMatchesVersion } from '../metadata/releaseTag.js'; export function MetadataForm({ form, @@ -218,113 +219,153 @@ export function MetadataForm({

Version, date, license, and identifiers

Use release-aligned values so your exports match what users see on GitHub and Zenodo.

-
- +
+
+

Release details

+
+ - {form.typeOfWork === 'other' && ( - - )} + {form.typeOfWork === 'other' && ( + + )} - + - + - + +
+
- +
+

Repository and release

+
+ - + - + +
+
+ +
+

Identifiers and keywords

+
+ + + +
+
diff --git a/src/core/metadataModel.js b/src/core/metadataModel.js index c19cb9a..d737d2e 100644 --- a/src/core/metadataModel.js +++ b/src/core/metadataModel.js @@ -18,6 +18,8 @@ * @property {string} version * @property {string} publicationDate - ISO 8601 date string (YYYY-MM-DD) * @property {string} repositoryCode - URL to code repository + * @property {string} releaseTag - actual GitHub release tag, when different from the version + * @property {string} releaseCommit - commit hash tagged with the release version * @property {string} doi * @property {string} abstract * @property {string[]} references @@ -39,6 +41,8 @@ export const emptyMetadata = { version: '', publicationDate: '', repositoryCode: '', + releaseTag: '', + releaseCommit: '', doi: '', abstract: '', references: [], diff --git a/src/metadata/normalizeMetadata.js b/src/metadata/normalizeMetadata.js index 1e07eeb..c56cc21 100644 --- a/src/metadata/normalizeMetadata.js +++ b/src/metadata/normalizeMetadata.js @@ -28,6 +28,8 @@ export function normalizeMetadata(form) { version: form.version ?? '', publicationDate: form.publicationDate ?? '', repositoryCode: form.repositoryCode ?? '', + releaseTag: form.releaseTag ?? '', + releaseCommit: form.releaseCommit ?? '', doi: form.doi ?? '', abstract: form.abstract ?? '', references, diff --git a/src/metadata/releaseTag.js b/src/metadata/releaseTag.js new file mode 100644 index 0000000..58d2711 --- /dev/null +++ b/src/metadata/releaseTag.js @@ -0,0 +1,14 @@ +function normalizeReleaseIdentifier(value) { + return String(value ?? '').trim().replace(/^v/i, ''); +} + +export function getDefaultReleaseTag(version) { + const normalizedVersion = normalizeReleaseIdentifier(version); + return normalizedVersion ? `v${normalizedVersion}` : ''; +} + +export function releaseTagMatchesVersion(version, releaseTag) { + const normalizedVersion = normalizeReleaseIdentifier(version); + const normalizedTag = normalizeReleaseIdentifier(releaseTag); + return Boolean(normalizedVersion && normalizedTag && normalizedVersion === normalizedTag); +} diff --git a/src/metadata/updateMetadataField.js b/src/metadata/updateMetadataField.js new file mode 100644 index 0000000..f5b655b --- /dev/null +++ b/src/metadata/updateMetadataField.js @@ -0,0 +1,21 @@ +import { getDefaultReleaseTag, releaseTagMatchesVersion } from './releaseTag.js'; + +export function updateMetadataField(form, name, value) { + if (form[name] === value) { + return form; + } + + if (name === 'version') { + const releaseTag = !form.releaseTag || releaseTagMatchesVersion(form.version, form.releaseTag) + ? getDefaultReleaseTag(value) + : form.releaseTag; + return { ...form, version: value, releaseTag, releaseCommit: '' }; + } + if (name === 'repositoryCode') { + return { ...form, repositoryCode: value, releaseTag: getDefaultReleaseTag(form.version), releaseCommit: '' }; + } + if (name === 'releaseTag') { + return { ...form, releaseTag: value, releaseCommit: '' }; + } + return { ...form, [name]: value }; +} diff --git a/src/services/citation.js b/src/services/citation.js index aa5b3d0..56f4e9f 100644 --- a/src/services/citation.js +++ b/src/services/citation.js @@ -153,9 +153,12 @@ function toCitationReferenceEntry(reference) { export function toCitationCff(metadata) { const typeOfWork = sanitizeCffType(metadata.typeOfWork, 'software'); const repositoryCode = metadata.repositoryCode || 'https://github.com/Imageomics/repository'; - const releaseTag = String(metadata.version ?? '').trim(); - const releaseUrl = releaseTag ? `${repositoryCode}/releases/tag/${releaseTag}` : ''; - const taggedTreeUrl = releaseTag ? `${repositoryCode}/tree/${releaseTag}` : ''; + const releaseTag = String(metadata.releaseTag ?? '').trim() || String(metadata.version ?? '').trim(); + const releaseUrl = releaseTag ? `${repositoryCode}/releases/tag/${encodeURIComponent(releaseTag)}` : ''; + const releaseCommit = String(metadata.releaseCommit ?? '').trim(); + const commitUrl = releaseTag && /^[0-9a-f]{7,40}$/i.test(releaseCommit) + ? `${repositoryCode}/commit/${releaseCommit}` + : ''; const authors = metadata.authors.map((author) => { const lines = [ `- family-names: "${quoteYAML(author.citationAuthor['family-names'])}"`, @@ -197,9 +200,13 @@ export function toCitationCff(metadata) { ` - description: "The GitHub release URL of tag ${quoteYAML(releaseTag)}."`, ' type: url', ` value: "${quoteYAML(releaseUrl)}"`, - ` - description: "The GitHub source tree URL aligned to release tag ${quoteYAML(releaseTag)}."`, - ' type: url', - ` value: "${quoteYAML(taggedTreeUrl)}"`, + ...(commitUrl + ? [ + ` - description: "The GitHub URL of the commit tagged with ${quoteYAML(releaseTag)}."`, + ' type: url', + ` value: "${quoteYAML(commitUrl)}" # Update on release`, + ] + : []), ] : []), 'keywords:', diff --git a/src/services/githubApi.js b/src/services/githubApi.js index 9e4376f..34c9edc 100644 --- a/src/services/githubApi.js +++ b/src/services/githubApi.js @@ -110,6 +110,10 @@ export function buildGithubCommitListApiUrl(owner, repo, defaultBranch = '', per return `${API_BASE}/repos/${owner}/${repo}/commits?per_page=${safePerPage}${branchFilter}`; } +export function buildGithubCommitApiUrl(owner, repo, ref) { + return `${API_BASE}/repos/${owner}/${repo}/commits/${encodeURIComponent(ref)}`; +} + export function buildGithubBranchApiUrl(owner, repo, branch) { return `${API_BASE}/repos/${owner}/${repo}/branches/${encodeURIComponent(branch)}`; } diff --git a/src/services/githubImporter.js b/src/services/githubImporter.js index 3ce8ddf..4290843 100644 --- a/src/services/githubImporter.js +++ b/src/services/githubImporter.js @@ -1,9 +1,11 @@ import { createMetadata } from '../core/metadataModel.js'; +import { releaseTagMatchesVersion } from '../metadata/releaseTag.js'; import { extractOrcidFromGithubProfile } from '../utils/orcid.js'; import { validateCitationCffText } from './citationValidation.js'; import { runCitationHealthScan } from './citationHealthScan.js'; import { buildGithubBranchApiUrl, + buildGithubCommitApiUrl, buildGithubCommitListApiUrl, buildGithubReleaseApiUrl, buildGithubReleaseListApiUrl, @@ -753,6 +755,22 @@ export async function importGithubMetadata(repoUrl, options = {}) { metadata.version = cleanString(releaseData.tag_name); } + const releaseTag = cleanString(releaseData?.tag_name ?? ''); + const versionMatchesReleaseTag = releaseTagMatchesVersion(metadata.version, releaseTag); + if (versionMatchesReleaseTag) { + metadata.releaseTag = releaseTag; + const tagCommit = await fetchOptionalJson( + buildGithubCommitApiUrl(owner, repo, releaseTag), + buildGithubRequestConfig({ + authToken, + source: 'release', + label: `the commit for tag ${releaseTag}`, + onWarning: (source, code, message, details = {}) => addWarning(warnings, source, code, message, details), + }), + ); + metadata.releaseCommit = /^[0-9a-f]{40}$/i.test(cleanString(tagCommit?.sha)) ? cleanString(tagCommit.sha) : ''; + } + if (!metadata.publicationDate) { metadata.publicationDate = cleanString(releaseData?.published_at ?? latestCommitDate ?? repoData.created_at).split('T')[0]; } @@ -815,4 +833,3 @@ export async function importGithubMetadata(repoUrl, options = {}) { return { metadata, warnings, errors, review, healthScan, comparisons }; } - diff --git a/src/styles.css b/src/styles.css index 9f9bec3..021fdbe 100644 --- a/src/styles.css +++ b/src/styles.css @@ -628,12 +628,42 @@ h1 { color: var(--text-secondary); } -.section-grid { +.release-tag-warning { + color: var(--status-warning-text); +} + +.publishing-groups { + display: grid; + gap: 20px; +} + +.metadata-group { + display: grid; + gap: 12px; +} + +.metadata-group + .metadata-group { + padding-top: 16px; + border-top: 1px solid var(--border-soft); +} + +.metadata-group h4 { + margin: 0; + color: var(--text-primary); + font-size: 0.94rem; +} + +.metadata-fields { display: grid; grid-template-columns: repeat(2, minmax(0, 1fr)); + align-items: start; gap: 16px; } +.metadata-fields small { + line-height: 1.4; +} + .required-note { margin: 0; font-size: 0.85rem; @@ -642,6 +672,7 @@ h1 { label { display: grid; + align-content: start; gap: 8px; } @@ -925,7 +956,7 @@ pre { grid-template-columns: 1fr; } - .section-grid { + .metadata-fields { grid-template-columns: 1fr; } } diff --git a/src/validation/validation.js b/src/validation/validation.js index 8b00ef0..18e898d 100644 --- a/src/validation/validation.js +++ b/src/validation/validation.js @@ -60,6 +60,8 @@ export function normalizeFormInput(form) { version: cleanString(form.version), publicationDate: cleanString(form.publicationDate), repositoryCode: cleanString(form.repositoryCode), + releaseTag: cleanString(form.releaseTag), + releaseCommit: cleanString(form.releaseCommit), doi: cleanString(form.doi), references: String(form.references ?? '').trim(), grants: String(form.grants ?? '').trim(), diff --git a/tests/components/metadataForm.test.js b/tests/components/metadataForm.test.js new file mode 100644 index 0000000..fba264f --- /dev/null +++ b/tests/components/metadataForm.test.js @@ -0,0 +1,59 @@ +import assert from 'node:assert/strict'; +import test from 'node:test'; +import React from 'react'; +import { renderToStaticMarkup } from 'react-dom/server'; +import { createServer } from 'vite'; + +const noop = () => {}; + +test('release tag mismatch is explained without changing the citation version', async () => { + const server = await createServer({ server: { middlewareMode: true }, appType: 'custom' }); + try { + const { MetadataForm } = await server.ssrLoadModule('/src/components/MetadataForm.jsx'); + const form = { + title: 'OpenCite', + abstract: '', + authors: [], + typeOfWork: 'software', + customTypeOfWork: '', + version: '2.0.0', + publicationDate: '', + license: 'MIT', + repositoryCode: 'https://github.com/Imageomics/OpenCite', + releaseTag: 'v1.1.0', + releaseCommit: '', + doi: '', + keywords: '', + references: '', + grants: '', + }; + const props = { + form, + typeOptions: [{ value: 'software', label: 'Software' }], + licenseOptions: ['MIT'], + updateField: noop, + updateAuthorField: noop, + appendGrantSuggestion: noop, + appendAllGrantSuggestions: noop, + suggestOrcid: noop, + applySuggestedOrcid: noop, + reorderAuthor: noop, + addAuthor: noop, + removeAuthor: noop, + }; + + const mismatch = renderToStaticMarkup(React.createElement(MetadataForm, props)); + assert.match(mismatch, /role="status"/); + assert.match(mismatch, /The GitHub tag "v1\.1\.0" does not match the cited version "2\.0\.0"/); + assert.match(mismatch, /Version to cite\*/); + assert.match(mismatch, /GitHub release tag/); + + const matching = renderToStaticMarkup(React.createElement(MetadataForm, { + ...props, + form: { ...form, releaseTag: 'v2.0.0' }, + })); + assert.doesNotMatch(matching, /release-tag-warning/); + } finally { + await server.close(); + } +}); diff --git a/tests/services/citationValidation.test.js b/tests/services/citationValidation.test.js index 23f892e..b4724ae 100644 --- a/tests/services/citationValidation.test.js +++ b/tests/services/citationValidation.test.js @@ -112,3 +112,55 @@ test('toCitationCff omits empty author name fields in references', () => { assert.doesNotMatch(output, /given-names: ""/); assert.match(output, /orcid: "https:\/\/orcid\.org\/0000-0002-1825-0097"/); }); + +const releaseMetadata = { + title: 'OpenCite', + authors: [{ citationAuthor: { 'given-names': 'Jane', 'family-names': 'Doe', orcid: '' } }], + keywords: [], + license: 'MIT', + typeOfWork: 'software', + customTypeOfWork: '', + version: '1.0.0', + publicationDate: '2026-07-12', + repositoryCode: 'https://github.com/Imageomics/OpenCite', + doi: '', + abstract: '', + references: [], + grants: [], +}; + +test('toCitationCff emits a commit URL for the release commit hash', () => { + const hash = '0123456789abcdef0123456789abcdef01234567'; + const output = toCitationCff({ ...releaseMetadata, releaseCommit: hash }); + + assert.match(output, /releases\/tag\/1\.0\.0/); + assert.match(output, /description: "The GitHub URL of the commit tagged with 1\.0\.0\."/); + assert.match(output, new RegExp(`value: "https://github.com/Imageomics/OpenCite/commit/${hash}" # Update on release`)); + assert.doesNotMatch(output, /\/tree\//); +}); + +test('toCitationCff uses the exact release tag while preserving the metadata version', () => { + const hash = '0123456789abcdef0123456789abcdef01234567'; + const output = toCitationCff({ ...releaseMetadata, version: '1.2.3', releaseTag: 'v1.2.3', releaseCommit: hash }); + + assert.match(output, /description: "The GitHub release URL of tag v1\.2\.3\."/); + assert.match(output, /value: "https:\/\/github\.com\/Imageomics\/OpenCite\/releases\/tag\/v1\.2\.3"/); + assert.match(output, /description: "The GitHub URL of the commit tagged with v1\.2\.3\."/); + assert.match(output, /version: "1\.2\.3"/); +}); + +test('toCitationCff encodes special characters in release tag URLs', () => { + const output = toCitationCff({ ...releaseMetadata, releaseTag: 'release/v1.0.0' }); + assert.match(output, /releases\/tag\/release%2Fv1\.0\.0/); + assert.match(output, /tag release\/v1\.0\.0/); +}); + +test('toCitationCff omits the commit identifier without a valid commit hash', () => { + for (const releaseCommit of [undefined, '', 'not-a-hash']) { + const output = toCitationCff({ ...releaseMetadata, releaseCommit }); + + assert.match(output, /releases\/tag\/1\.0\.0/); + assert.doesNotMatch(output, /\/commit\//); + assert.doesNotMatch(output, /\/tree\//); + } +}); diff --git a/tests/services/githubImporter.test.js b/tests/services/githubImporter.test.js index 83fbd12..83ee516 100644 --- a/tests/services/githubImporter.test.js +++ b/tests/services/githubImporter.test.js @@ -1785,3 +1785,114 @@ test('importGithubMetadata deduplicates likely name variants between citation an globalThis.fetch = originalFetch; } }); + +test('importGithubMetadata resolves the commit hash for a release tag matching the version', async () => { + const originalFetch = globalThis.fetch; + const sha = '0123456789abcdef0123456789abcdef01234567'; + + globalThis.fetch = async (url) => { + const value = String(url); + + if (value.endsWith('/repos/test-owner/test-repo')) { + return Response.json({ + name: 'test-repo', + html_url: 'https://github.com/test-owner/test-repo', + default_branch: 'main', + topics: [], + license: { spdx_id: 'MIT' }, + created_at: '2025-01-01T00:00:00Z', + }); + } + + if (value.endsWith('/repos/test-owner/test-repo/releases?per_page=1')) { + return Response.json([{ tag_name: 'v1.2.3', published_at: '2025-02-01T00:00:00Z' }]); + } + + if (value.endsWith('/repos/test-owner/test-repo/commits/v1.2.3')) { + return Response.json({ sha }); + } + + if (value.includes('/repos/test-owner/test-repo/commits?')) { + return Response.json([{ commit: { committer: { date: '2025-01-02T00:00:00Z' } } }]); + } + + if (value.includes('/repos/test-owner/test-repo/contributors?')) { + return Response.json([]); + } + + throw new Error(`Unexpected fetch URL: ${value}`); + }; + + try { + const result = await importGithubMetadata('https://github.com/test-owner/test-repo', { lookupExternalDoi: false }); + + assert.equal(result.metadata.version, 'v1.2.3'); + assert.equal(result.metadata.releaseTag, 'v1.2.3'); + assert.equal(result.metadata.releaseCommit, sha); + } finally { + globalThis.fetch = originalFetch; + } +}); + +test('importGithubMetadata resolves only release tags matching the citation version', async () => { + const originalFetch = globalThis.fetch; + const sha = '0123456789abcdef0123456789abcdef01234567'; + let version = '1.2.3'; + const requestedUrls = []; + + globalThis.fetch = async (url) => { + const value = String(url); + requestedUrls.push(value); + if (value.endsWith('/repos/test-owner/test-repo')) { + return Response.json({ + name: 'test-repo', + html_url: 'https://github.com/test-owner/test-repo', + default_branch: 'main', + topics: [], + license: { spdx_id: 'MIT' }, + created_at: '2025-01-01T00:00:00Z', + }); + } + if (value.endsWith('/repos/test-owner/test-repo/releases?per_page=1')) { + return Response.json([{ tag_name: 'v1.2.3', published_at: '2025-02-01T00:00:00Z' }]); + } + if (value.endsWith('/repos/test-owner/test-repo/commits/v1.2.3')) { + return Response.json({ sha }); + } + if (value.includes('/repos/test-owner/test-repo/commits?')) { + return Response.json([{ commit: { committer: { date: '2025-01-02T00:00:00Z' } } }]); + } + if (value.includes('/repos/test-owner/test-repo/contents/CITATION.cff?ref=main')) { + const citation = `cff-version: 1.2.0\ntitle: "OpenCite"\nversion: "${version}"\ndate-released: "2025-01-02"\nrepository-code: "https://github.com/test-owner/test-repo"\nauthors:\n - family-names: "Doe"\n given-names: "Jane"\n`; + return Response.json({ encoding: 'base64', content: Buffer.from(citation).toString('base64') }); + } + if (value.includes('/repos/test-owner/test-repo/contents/')) { + return new Response(JSON.stringify({ message: 'Not Found' }), { status: 404 }); + } + if (value.includes('/repos/test-owner/test-repo/contributors?')) { + return Response.json([]); + } + throw new Error(`Unexpected fetch URL: ${value}`); + }; + + try { + const options = { lookupExternalDoi: false }; + const matching = await importGithubMetadata('https://github.com/test-owner/test-repo', options); + assert.deepEqual(matching.errors, []); + assert.equal(matching.metadata.version, '1.2.3'); + assert.equal(matching.metadata.releaseTag, 'v1.2.3'); + assert.equal(matching.metadata.releaseCommit, sha); + assert.equal(requestedUrls.filter((url) => url.endsWith('/commits/v1.2.3')).length, 1); + + version = '2.0.0'; + requestedUrls.length = 0; + const mismatched = await importGithubMetadata('https://github.com/test-owner/test-repo', options); + assert.deepEqual(mismatched.errors, []); + assert.equal(mismatched.metadata.version, '2.0.0'); + assert.equal(mismatched.metadata.releaseTag, ''); + assert.equal(mismatched.metadata.releaseCommit, ''); + assert.equal(requestedUrls.some((url) => url.endsWith('/commits/v1.2.3')), false); + } finally { + globalThis.fetch = originalFetch; + } +}); diff --git a/tests/validation/validation.test.js b/tests/validation/validation.test.js index 9dab20d..3a10000 100644 --- a/tests/validation/validation.test.js +++ b/tests/validation/validation.test.js @@ -2,6 +2,10 @@ import test from 'node:test'; import assert from 'node:assert/strict'; import { normalizeFormInput, validateMetadata } from '../../src/validation/validation.js'; +import { normalizeMetadata } from '../../src/metadata/normalizeMetadata.js'; +import { getDefaultReleaseTag, releaseTagMatchesVersion } from '../../src/metadata/releaseTag.js'; +import { updateMetadataField } from '../../src/metadata/updateMetadataField.js'; +import { toCitationCff } from '../../src/services/citation.js'; const typeOptions = [ { value: 'article', label: 'Article' }, @@ -35,6 +39,44 @@ function createBaseForm() { }; } +test('release tag survives form normalization and is used in citation identifiers', () => { + const form = { + ...createBaseForm(), + releaseTag: ' v1.2.3 ', + releaseCommit: '0123456789abcdef0123456789abcdef01234567', + }; + const metadata = normalizeMetadata(normalizeFormInput(form)); + assert.equal(metadata.releaseTag, 'v1.2.3'); + assert.equal(metadata.version, '1.2.3'); + assert.match(toCitationCff(metadata), /releases\/tag\/v1\.2\.3/); + assert.match(toCitationCff(metadata), /commit tagged with v1\.2\.3/); +}); + +test('editing release identity clears stale tag and commit fields', () => { + const form = { version: '1.2.3', repositoryCode: 'https://github.com/a/b', releaseTag: 'v1.2.3', releaseCommit: 'abcdef1', title: 'Title' }; + assert.deepEqual(updateMetadataField(form, 'version', '2.0.0'), { ...form, version: '2.0.0', releaseTag: 'v2.0.0', releaseCommit: '' }); + assert.deepEqual(updateMetadataField(form, 'repositoryCode', 'https://github.com/c/d'), { ...form, repositoryCode: 'https://github.com/c/d', releaseTag: 'v1.2.3', releaseCommit: '' }); + assert.deepEqual(updateMetadataField(form, 'releaseTag', '1.2.3'), { ...form, releaseTag: '1.2.3', releaseCommit: '' }); + assert.deepEqual(updateMetadataField(form, 'title', 'New title'), { ...form, title: 'New title' }); + assert.strictEqual(updateMetadataField(form, 'version', '1.2.3'), form); +}); + +test('release tags default to v plus the version and detect mismatches', () => { + assert.equal(getDefaultReleaseTag('1.2.3'), 'v1.2.3'); + assert.equal(getDefaultReleaseTag('v1.2.3'), 'v1.2.3'); + assert.equal(getDefaultReleaseTag(''), ''); + assert.equal(releaseTagMatchesVersion('1.2.3', 'v1.2.3'), true); + assert.equal(releaseTagMatchesVersion('v1.2.3', '1.2.3'), true); + assert.equal(releaseTagMatchesVersion('2.0.0', 'v1.1.0'), false); + + const customTagForm = { version: '2.0.0', releaseTag: 'v1.1.0', releaseCommit: 'abcdef1' }; + assert.deepEqual(updateMetadataField(customTagForm, 'version', '2.1.0'), { + ...customTagForm, + version: '2.1.0', + releaseCommit: '', + }); +}); + test('validateMetadata flags duplicate authors by normalized name', () => { const form = createBaseForm(); form.authors.push({