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

ci: Mono repo setup #4742

Merged
merged 45 commits into from May 16, 2024
Merged

ci: Mono repo setup #4742

merged 45 commits into from May 16, 2024

Conversation

frascuchon
Copy link
Member

@frascuchon frascuchon commented Apr 24, 2024

The mono repo structure will divide the argilla repository into different folders,
each one containing a different part of the project.

The .github/workflows folder will contain the different workflows for each part of the project because of the
limitation of GitHub Actions to have only one workflow folder per repository.

The docs (or argilla-docs) folder will contain the documentation for the whole project.

The rest of the folders will contain the different parts of the project, such as the SDK,
the frontend, and the server.

Each part of the project will have its own CHANGELOG.md file and its own README.md file.

Contribution guidelines will be in the CONTRIBUTING.md file and the code of conduct will be in the CODE_OF_CONDUCT.md file.

A example of the project structure would be:

- .github/workflows/
    |_ argilla.yml # test + build argilla
    |_ argilla-frontend.yml # test + build argilla-frontend
    |_ argilla-server.yml # test + build argilla-server
    ...
- argilla-sdk/ #  -> V2
    |_ CHANGELOG.md
    |_ README.md
    |_ src/
    |_ tests/
    ...
- argilla/ # -> V1
    |_ CHANGELOG.md
    |_ README.md
    |_ src/
    |_ tests/
    ...
- argilla-frontend/
    |_ CHANGELOG.md
    |_ README.md
    |_ package.json
    |_ nuxt.config.ts
	...
- argilla-server/
    |_ CHANGELOG.md
    |_ README.md
    |_ src/
    |_ tests/
    ...
- docs/
    ...
- CONTRIBUTING.md
- CODE_OF_CONDUCT.md
...

@dosubot dosubot bot added size:S This PR changes 10-29 lines, ignoring generated files. area: ci Indicates that an issue or pull request is related to the Continuous Integration (CI) labels Apr 24, 2024
@dosubot dosubot bot added size:M This PR changes 30-99 lines, ignoring generated files. and removed size:S This PR changes 10-29 lines, ignoring generated files. labels Apr 24, 2024
Copy link

The URL of the deployed environment for this PR is https://argilla-quickstart-pr-4742-ki24f765kq-no.a.run.app

@dosubot dosubot bot added size:XL This PR changes 500-999 lines, ignoring generated files. and removed size:M This PR changes 30-99 lines, ignoring generated files. labels Apr 24, 2024
@frascuchon frascuchon force-pushed the ci/configure-mono-repo branch 5 times, most recently from 9a38b9f to 4b17e53 Compare April 24, 2024 11:05
@frascuchon frascuchon force-pushed the ci/configure-mono-repo branch 2 times, most recently from 38a3518 to 1720536 Compare April 30, 2024 08:51
pre-commit-ci bot and others added 2 commits April 30, 2024 09:06
<!-- Thanks for your contribution! As part of our Community Growers
initiative 🌱, we're donating Justdiggit bunds in your name to reforest
sub-Saharan Africa. To claim your Community Growers certificate, please
contact David Berenstein in our Slack community or fill in this form
https://tally.so/r/n9XrxK once your PR has been merged. -->

# Description

This PR adds a basic workflow to build and deploy the `argilla-frontend`
project. The workflow tests and builds frontend resources, uploads
static distribution as an artifact, builds a dev docker image and
deploys it in an isolated environment.



**Type of change**

(Please delete options that are not relevant. Remember to title the PR
according to the type of change)

- [ ] New feature (non-breaking change which adds functionality)
- [ ] Refactor (change restructuring the codebase without changing
functionality)
- [ ] Improvement (change adding some improvement to an existing
functionality)

**How Has This Been Tested**

(Please describe the tests that you ran to verify your changes. And
ideally, reference `tests`)

- [ ] Test A
- [ ] Test B

**Checklist**

- [ ] I added relevant documentation
- [ ] I followed the style guidelines of this project
- [ ] I did a self-review of my code
- [ ] I made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK)
(see text above)
- [ ] I have added relevant notes to the `CHANGELOG.md` file (See
https://keepachangelog.com/)

---------

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: José Francisco Calvo <jose@argilla.io>
@frascuchon frascuchon changed the title ci: Configure mono repo ci: Prepare mono repo setup May 10, 2024
frascuchon and others added 5 commits May 10, 2024 13:41
Co-authored-by: José Francisco Calvo <jose@argilla.io>
<!-- Thanks for your contribution! As part of our Community Growers
initiative 🌱, we're donating Justdiggit bunds in your name to reforest
sub-Saharan Africa. To claim your Community Growers certificate, please
contact David Berenstein in our Slack community or fill in this form
https://tally.so/r/n9XrxK once your PR has been merged. -->

# Description

Moving the argilla project to `argilla` folder. 



**Type of change**

(Please delete options that are not relevant. Remember to title the PR
according to the type of change)

- [ ] New feature (non-breaking change which adds functionality)
- [ ] Refactor (change restructuring the codebase without changing
functionality)
- [ ] Improvement (change adding some improvement to an existing
functionality)

**How Has This Been Tested**

(Please describe the tests that you ran to verify your changes. And
ideally, reference `tests`)

- [ ] Test A
- [ ] Test B

**Checklist**

- [ ] I added relevant documentation
- [ ] I followed the style guidelines of this project
- [ ] I did a self-review of my code
- [ ] I made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK)
(see text above)
- [ ] I have added relevant notes to the `CHANGELOG.md` file (See
https://keepachangelog.com/)
<!-- Thanks for your contribution! As part of our Community Growers
initiative 🌱, we're donating Justdiggit bunds in your name to reforest
sub-Saharan Africa. To claim your Community Growers certificate, please
contact David Berenstein in our Slack community or fill in this form
https://tally.so/r/n9XrxK once your PR has been merged. -->

# Description

This PR moves files from `frontend` to `argilla-frontend`

**Type of change**

(Please delete options that are not relevant. Remember to title the PR
according to the type of change)

- [ ] New feature (non-breaking change which adds functionality)
- [ ] Refactor (change restructuring the codebase without changing
functionality)
- [ ] Improvement (change adding some improvement to an existing
functionality)

**How Has This Been Tested**

(Please describe the tests that you ran to verify your changes. And
ideally, reference `tests`)

- [ ] Test A
- [ ] Test B

**Checklist**

- [ ] I added relevant documentation
- [ ] I followed the style guidelines of this project
- [ ] I did a self-review of my code
- [ ] I made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK)
(see text above)
- [ ] I have added relevant notes to the `CHANGELOG.md` file (See
https://keepachangelog.com/)
# Description

Add `argilla-server` to his own folder using code from
argilla-io/argilla-server#168

The following code has been removed/changed:
* Folder `/.github` has not been copied from `argilla-server`.
* Submodule `argilla` has not been copied from `argilla-server`.

**Type of change**

(Please delete options that are not relevant. Remember to title the PR
according to the type of change)

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [x] Refactor (change restructuring the codebase without changing
functionality)
- [ ] Improvement (change adding some improvement to an existing
functionality)
- [ ] Documentation update

**How Has This Been Tested**

- [ ] Build should be successfully created.

**Checklist**

- [ ] I added relevant documentation
- [ ] follows the style guidelines of this project
- [ ] I did a self-review of my code
- [ ] I made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK)
(see text above)
- [ ] I have added relevant notes to the CHANGELOG.md file (See
https://keepachangelog.com/)
@frascuchon frascuchon added this to the v1.29.0 milestone May 14, 2024
@frascuchon frascuchon changed the title ci: Prepare mono repo setup ci: Mono repo setup May 14, 2024
jfcalvo and others added 9 commits May 14, 2024 11:36
# Description

We will use this PR to check that GitHub Actions are working as expected
for `argilla` folder, integrated with new `argilla-server` project.

**Type of change**

(Please delete options that are not relevant. Remember to title the PR
according to the type of change)

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to not work as expected)
- [ ] Refactor (change restructuring the codebase without changing
functionality)
- [ ] Improvement (change adding some improvement to an existing
functionality)
- [ ] Documentation update

**How Has This Been Tested**

(Please describe the tests that you ran to verify your changes. And
ideally, reference `tests`)

- [ ] Test A
- [ ] Test B

**Checklist**

- [ ] I added relevant documentation
- [ ] follows the style guidelines of this project
- [ ] I did a self-review of my code
- [ ] I made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK)
(see text above)
- [ ] I have added relevant notes to the CHANGELOG.md file (See
https://keepachangelog.com/)
<!-- Thanks for your contribution! As part of our Community Growers
initiative 🌱, we're donating Justdiggit bunds in your name to reforest
sub-Saharan Africa. To claim your Community Growers certificate, please
contact David Berenstein in our Slack community or fill in this form
https://tally.so/r/n9XrxK once your PR has been merged. -->

# Description

This PR moves files related to deployment setup into an
`examples/deployments` folder.

**Type of change**

(Please delete options that are not relevant. Remember to title the PR
according to the type of change)

- [ ] New feature (non-breaking change which adds functionality)
- [ ] Refactor (change restructuring the codebase without changing
functionality)
- [x] Improvement (change adding some improvement to an existing
functionality)

**How Has This Been Tested**

(Please describe the tests that you ran to verify your changes. And
ideally, reference `tests`)

- [ ] Test A
- [ ] Test B

**Checklist**

- [ ] I added relevant documentation
- [ ] I followed the style guidelines of this project
- [ ] I did a self-review of my code
- [ ] I made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my
feature works
- [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK)
(see text above)
- [ ] I have added relevant notes to the `CHANGELOG.md` file (See
https://keepachangelog.com/)

---------

Co-authored-by: José Francisco Calvo <jose@argilla.io>
<!-- Thanks for your contribution! As part of our Community Growers
initiative 🌱, we're donating Justdiggit bunds in your name to reforest
sub-Saharan Africa. To claim your Community Growers certificate, please
contact David Berenstein in our Slack community or fill in this form
https://tally.so/r/n9XrxK once your PR has been merged. -->

# Description

This PR reviews the development docs related to this new mono repo
structure. I realized that some of those docs were outdated. These docs
will be revisited in future PRs.

**Type of change**

(Remember to title the PR according to the type of change)

- [ ] Documentation update

**How Has This Been Tested**

(Please describe the tests that you ran to verify your changes.)

- [ ] `sphinx-autobuild` (read [Developer
Documentation](https://docs.argilla.io/en/latest/community/developer_docs.html#building-the-documentation)
for more details)

**Checklist**

- [ ] I added relevant documentation
- [ ] I followed the style guidelines of this project
- [ ] I did a self-review of my code
- [ ] I made corresponding changes to the documentation
- [ ] My changes generate no new warnings
- [ ] I filled out [the contributor form](https://tally.so/r/n9XrxK)
(see text above)
- [ ] I have added relevant notes to the `CHANGELOG.md` file (See
https://keepachangelog.com/)

---------

Co-authored-by: Natalia Elvira <126158523+nataliaElv@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
@jfcalvo
Copy link
Member

jfcalvo commented May 16, 2024

@damianpumar @leiyre can you take a look to the commit 7e7ff96 updating argilla-frontend folder with the latests changes from develop before merging the PR?

@jfcalvo jfcalvo merged commit 66bebda into develop May 16, 2024
5 checks passed
@jfcalvo jfcalvo deleted the ci/configure-mono-repo branch May 16, 2024 15:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: ci Indicates that an issue or pull request is related to the Continuous Integration (CI) size:XL This PR changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants