Skip to content
This repository was archived by the owner on Feb 15, 2022. It is now read-only.
This repository was archived by the owner on Feb 15, 2022. It is now read-only.

Restructure bedrock-cli repo #1153

@sarath-p

Description

@sarath-p

As a:

Developer

Make changes to SPK repo to prepare for merging into the Bedrock repo.

I want:

To make changes to existing SPK repo for easier migration to Bedrock repo.

Describe the solution you'd like:

Make changes to the existing SPK repo as defined in the Acceptance criteria section below.

Current SPK repo

├── .github
├── azure-pipelines
    ├── templates
├── docs
    ├── commands
├── guides
├── patches
├── scripts
├── src
├── technical-docs
    ├── designs
├── tests
├── tools
├── typings
    ├── ssh-url
├── .editorconfig
├── .env.example
├── .gitignore
├── CHANGELOG.md
├── README.md
├── azure-pipelines.yml
├── jest.config.js
├── package.json
├── release-pipeline.yml
├── smoke-test-pipeline.yml
├── spk-config.yaml
├── tsconfig.json
├── tslint.json
├── typings
├── webpack.config.js
├── .yarn.lock

Acceptance Criteria:

  • Move following files from the root to build\pipelines folder and make sure all pipelines continue to work.
    • azure-pipelines.yml
    • release-pipeline.yml
    • smoke-test-pipeline.yml
  • Move following files from the scripts to build\tools folder and verify the scripts generate command docs.
    • generateDoc.ts
    • locateAliases.ts
  • Move patches directory to build\patches folder and make sure yarn build and yarn test continue to work.
  • Move azure-pipelines\templates folder to build\pipelines\templates folder and verify all pipelines continue to work.
  • Move guides\contributing.md file to docs\contribution folder
  • Move guides folder to docs folder
  • Move technical-docs\designs to docs\contribution\designs folder

SPK repo after implementing above changes

├── .github
├── build
    ├── pipelines
        ├── templates
        ├── azure-pipelines.yml
        ├── release-pipeline.yml
        ├── smoke-test-pipeline.yml
     ├── patches
        ├── 001-azure-devops-node.patch
     ├── tools / scripts
        ├── generateDoc.ts
        ├── locateAliases.ts
        ├── release-version-bump.sh
        ├── tag-release.sh
        ├── update_introspection.sh
├── docs
    ├── commands
    ├── contribution
        ├── contributing.md
        ├── designs
    ├── guides
├── src
    ├── lib
    ├── commands / cli / cmd
    ├── logger
├── tests
├── typings
    ├── ssh-url
├── .editorconfig
├── .gitignore
├── jest.config.js
├── tsconfig.json
├── tslint.json
├── CHANGELOG.md
├── README.md
├── package.json
├── webpack.config.js
├── .yarn.lock

Does this require updates to documentation?:
No

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions