Skip to content
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.

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

specs: Move to dedicated repo #9121

Merged
merged 1 commit into from
Jan 22, 2024
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
53 changes: 0 additions & 53 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -665,51 +665,6 @@ jobs:
command: ./ops/scripts/todo-checker.sh --verbose
- notify-failures-on-develop

bedrock-markdown:
machine:
image: <<pipeline.parameters.base_image>>
steps:
- checkout
- check-changed:
patterns: specs/(.*)\.md$
- run:
name: Install pnpm package manager
command: |
npm i pnpm --global
- run:
name: pnpm dev deps
command: pnpm install:ci
- run:
name: specs toc
command: pnpm lint:specs:toc && git diff --exit-code ./specs
- run:
name: markdown lint
command: pnpm lint:specs:check

bedrock-markdown-links:
machine:
image: <<pipeline.parameters.base_image>>
steps:
- checkout
- run:
name: Install pnpm package manager
command: |
npm i pnpm --global
- run:
name: Install node_modules
command: |
pnpm install:ci
- run:
name: Lint check
command: |
pnpm lint:specs:check
- run:
name: link lint
command: |
make bedrock-markdown-links
- notify-failures-on-develop:
channel: C055R639XT9 #notify-link-check

fuzz-golang:
parameters:
package_name:
Expand Down Expand Up @@ -1461,7 +1416,6 @@ workflows:
requires:
- "go-mod-tidy"
- l1-geth-version-check
- bedrock-markdown
- go-lint: # we combine most of the go-lint work for two reasons: (1) warm up the Go build cache, (2) reduce sum of lint time
name: op-stack-go-lint
requires: [ "go-mod-tidy" ]
Expand Down Expand Up @@ -1879,13 +1833,6 @@ workflows:
- slack
- oplabs-fpp-nodes

scheduled-link-check:
when:
equal: [ build_daily, <<pipeline.schedule.name>> ]
jobs:
- bedrock-markdown-links:
context: slack

scheduled-docker-publish:
when:
equal: [ build_hourly, <<pipeline.schedule.name>> ]
Expand Down
12 changes: 0 additions & 12 deletions .markdownlint.json

This file was deleted.

8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,10 @@ In this repository, you'll find numerous core components of the OP Stack, the de

- If you want to build on top of OP Mainnet, refer to the [Optimism Documentation](https://docs.optimism.io)
- If you want to build your own OP Stack based blockchain, refer to the [OP Stack Guide](https://docs.optimism.io/stack/getting-started)
- If you want to contribute to the OP Stack, check out the [Protocol Specs](./specs)

## Specification

If you're interested in the technical details of how Optimism works, refer to the [Optimism Protocol Specification](https://github.com/ethereum-optimism/specs).

## Community

Expand Down Expand Up @@ -62,8 +65,7 @@ The Optimism Immunefi program offers up to $2,000,042 for in-scope critical vuln
│ ├── <a href="./packages/contracts-bedrock">contracts-bedrock</a>: Bedrock smart contracts
│ ├── <a href="./packages/core-utils">core-utils</a>: Low-level utilities that make building Optimism easier
│ └── <a href="./packages/sdk">sdk</a>: provides a set of tools for interacting with Optimism
├── <a href="./proxyd">proxyd</a>: Configurable RPC request router and proxy
└── <a href="./specs">specs</a>: Specs of the rollup starting at the Bedrock upgrade
└── <a href="./proxyd">proxyd</a>: Configurable RPC request router and proxy
</pre>

## Branching Model
Expand Down
2 changes: 1 addition & 1 deletion nx.json
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
},
"targetDefaults": {
"lint": {
"inputs": ["{workspaceRoot}/.markdownlint.json", "default"]
"inputs": ["default"]
},
"test": {
"inputs": ["default", "testing", "^production"],
Expand Down
5 changes: 0 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,6 @@
"lint:ts:check": "npx nx run-many --target=lint:ts:check",
"lint:check": "npx nx run-many --target=lint:check",
"lint:fix": "npx nx run-many --target=lint:fix",
"lint:specs:fix": "npx markdownlint-cli2-fix \"./specs/**/*.md\"",
"lint:specs:check": "npx markdownlint-cli2 \"./specs/**/*.md\"",
"lint:specs:toc": "npx doctoc '--title=**Table of Contents**' ./specs",
"preinstall": "npx only-allow pnpm",
"ready": "pnpm lint && pnpm test",
"prepare": "husky install",
Expand Down Expand Up @@ -67,8 +64,6 @@
"eslint-plugin-unicorn": "^50.0.1",
"husky": "^8.0.3",
"lint-staged": "15.2.0",
"markdownlint": "^0.33.0",
"markdownlint-cli2": "0.4.0",
"mocha": "^10.2.0",
"nx": "17.2.8",
"nyc": "^15.1.0",
Expand Down
142 changes: 0 additions & 142 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading