Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
stevespringett committed Dec 4, 2024
1 parent f856393 commit 449934d
Show file tree
Hide file tree
Showing 12 changed files with 5,569 additions and 2 deletions.
9 changes: 9 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
root = true

[*]
charset = utf-8
indent_style = space
indent_size = 2
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
11 changes: 11 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
version: 2
updates:
- package-ecosystem: "npm"
directory: "/"
schedule:
interval: "daily"

- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "daily"
43 changes: 43 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: 'Build on CI'

on: [pull_request, push, workflow_dispatch]

permissions:
contents: read
pages: write
id-token: write

jobs:
build:
name: 'Build Documentation'
runs-on: ubuntu-22.04

steps:
- name: Checkout Code
uses: actions/checkout@v4

- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: '20'
cache: 'npm'

- name: Cache npm dependencies
uses: actions/cache@v4
with:
path: ~/.npm
key: npm-cache-${{ runner.os }}-${{ hashFiles('**/package-lock.json') }}
restore-keys: |
npm-cache-${{ runner.os }}-
- name: Install Dependencies
run: npm install

- name: Build Project
run: npm run build-head

- name: Archive "out" Directory
uses: actions/upload-artifact@v4
with:
name: documentation-snapshot
path: ./out
58 changes: 58 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
name: 'Build and Deploy Documentation'

on:
push:
branches:
- main
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

jobs:
build:
name: 'Build Documentation'
runs-on: ubuntu-22.04

steps:
- name: Checkout Code
uses: actions/checkout@v4

- name: Set up Node.js
uses: actions/setup-node@v4
with:
node-version: '20'
cache: 'npm'

- name: Cache npm dependencies
uses: actions/cache@v4
with:
path: ~/.npm
key: npm-cache-${{ runner.os }}-${{ hashFiles('**/package-lock.json') }}
restore-keys: |
npm-cache-${{ runner.os }}-
- name: Install Dependencies
run: npm install

- name: Build Project
run: npm run build-only

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: ./out

deploy:
name: Deploy Documentation
needs: build
runs-on: ubuntu-latest
permissions:
pages: write
id-token: write

steps:
- name: Deploy to GitHub Pages
uses: actions/deploy-pages@v4
9 changes: 9 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
node_modules/
out/
vendor/esmeta
test*.js
aspell.txt

# lockfiles we don't use are ignored
npm-shrinkwrap.json
yarn.lock
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
v20.14.0
32 changes: 30 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,30 @@
# ECMA-xxx-CLE
This repository will be renamed once an ECMA identifier is assigned to the standard.
# ECMA-xxx-CLE (Common Lifecycle Enumeration Specification)

This repository hosts the work-in-progress technical specification for **Common Lifecycle Enumeration (CLE)**, which is being developed under Ecma International's **Technical Committee 54 (TC54)**. CLE addresses the growing need for a consistent and interoperable mechanism to represent lifecycle stages. As software supply chain management becomes increasingly critical, the ability to reliably communicate lifecycle information across diverse ecosystems is essential for improving security, compliance, and overall efficiency.

## Purpose of the Repository

This repository serves as the primary workspace for drafting, reviewing, and refining the CLE specification.

### Key Objectives
- Define a clear, extensible structure for lifecycle events that applies to diverse domains, including software, hardware, and digital assets.
- Enable consistent communication of lifecycle information across organisational boundaries.
- Support supply chain transparency, compliance, and risk management practices through reliable lifecycle categorisation.

### Important Note on Repository Name

This repository is currently named `ECMA-xxx-CLE` as a placeholder. Upon ratification of the CLE specification as an Ecma International standard, the repository will be renamed to **`ECMA-xxx`**, where `xxx` represents the number assigned by Ecma to the standard.

## Contributing

Contributions to this specification are managed by TC54. If you are part of the TC54 community or have been invited to collaborate, please follow the contribution guidelines outlined in this repository.

For general inquiries or feedback, you may contact Ecma International or TC54 through the official Ecma channels.

## License

This work is licensed under the terms defined by Ecma International, ensuring free access and adoption of the finalised specification.

## Acknowledgements

We thank Ecma International’s TC39 for their development of **Ecmarkup**, which TC54 has successfully adopted for preparing and maintaining this specification.
120 changes: 120 additions & 0 deletions img/ecma-logo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/favicon.ico
Binary file not shown.
Loading

0 comments on commit 449934d

Please sign in to comment.