Skip to content

Commit

Permalink
Merge pull request #1242 from mindsdb/sdlc
Browse files Browse the repository at this point in the history
Prepare for renaming default branch
  • Loading branch information
hamishfagg authored Dec 10, 2024
2 parents 3a9d7f1 + 582ad76 commit e342d65
Show file tree
Hide file tree
Showing 11 changed files with 52 additions and 56 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/benchmark_check.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Benchmark Result Check Lightwood
on:
pull_request:
branches:
- stable
- main

jobs:
check:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/cla.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@ jobs:
path-to-signatures: 'assets/contributions-agreement/signatures/cla.json'
# Add path to the CLA here
path-to-cla-document: 'https://github.com/mindsdb/mindsdb_native/blob/stable/assets/contributions-agreement/individual-contributor.md'
branch: 'staging'
branch: 'main'
allowlist: bot*, George3d6, ZoranPandovski, paxcema, torrmal, Stpmax, maximlopin, mindsdbadmin
2 changes: 1 addition & 1 deletion .github/workflows/doc_build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Documentation Build Lightwood
on:
push:
branches:
- staging
- main
- separate_doc_branch
- jupyter_actions

Expand Down
5 changes: 2 additions & 3 deletions .github/workflows/lightwood.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ on:
push:
pull_request:
branches:
- stable
- staging
- main
release:
types: [published]

Expand Down Expand Up @@ -47,7 +46,7 @@ jobs:
runs-on: ubuntu-latest
environment: PublishCI
needs: test
if: github.ref == 'refs/heads/stable' || github.event_name == 'release'
if: github.ref == 'refs/heads/main' || github.event_name == 'release'
steps:
- uses: actions/checkout@v2
- name: Set up Python
Expand Down
11 changes: 5 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,10 @@ If you are participating in this year's Hacktoberfest event, please scroll down
In general, we follow the ["fork-and-pull"](https://docs.github.com/en/github/collaborating-with-pull-requests/getting-started/about-collaborative-development-models#fork-and-pull-model) git workflow. Here are the steps:

1. Fork the Lightwood repository
2. Checkout the `staging` branch, which is the development version that gets released weekly (there can be exceptions, but make sure to ask and confirm with us).
3. Make changes and commit them
4. Make sure that the CI tests pass. You can run the test suite locally with `flake8 .` to check style and `python -m unittest discover tests` to run the automated tests. This doesn't guarantee it will pass remotely since we run on multiple envs, but should work in most cases.
5. Push your local branch to your fork
6. Submit a pull request from your repo to the `staging` branch of `mindsdb/lightwood` so that we can review your changes. Be sure to merge the latest from staging before making a pull request!
2. Make changes and commit them
3. Make sure that the CI tests pass. You can run the test suite locally with `flake8 .` to check style and `python -m unittest discover tests` to run the automated tests. This doesn't guarantee it will pass remotely since we run on multiple envs, but should work in most cases.
4. Push your local branch to your fork
5. Submit a pull request from your repo to the `main` branch of `mindsdb/lightwood` so that we can review your changes. Be sure to merge the latest from main before making a pull request!


> Note: You will need to sign a CLI agreement for the code since lightwood is under a GPL license.
Expand Down Expand Up @@ -82,4 +81,4 @@ Please check https://mindsdb.com/hacktoberfest for more details.


## Contributor Code of Conduct
Please note that this project is released with a [Contributor Code of Conduct](https://github.com/mindsdb/lightwood/blob/stable/CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
Please note that this project is released with a [Contributor Code of Conduct](https://github.com/mindsdb/lightwood/blob/main/CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -165,11 +165,10 @@ Please continue reading this guide if you are interested in helping democratize
In general, we follow the ["fork-and-pull"](https://docs.github.com/en/github/collaborating-with-pull-requests/getting-started/about-collaborative-development-models#fork-and-pull-model) git workflow. Here are the steps:

1. Fork the Lightwood repository
2. Checkout the `staging` branch, which is the development version that gets released weekly (there can be exceptions, but make sure to ask and confirm with us).
3. Make changes and commit them
4. Make sure that the CI tests pass. You can run the test suite locally with `flake8 .` to check style and `python -m unittest discover tests` to run the automated tests. This doesn't guarantee it will pass remotely since we run on multiple envs, but should work in most cases.
5. Push your local branch to your fork
6. Submit a pull request from your repo to the `staging` branch of `mindsdb/lightwood` so that we can review your changes. Be sure to merge the latest from staging before making a pull request!
2. Make changes and commit them
3. Make sure that the CI tests pass. You can run the test suite locally with `flake8 .` to check style and `python -m unittest discover tests` to run the automated tests. This doesn't guarantee it will pass remotely since we run on multiple envs, but should work in most cases.
4. Push your local branch to your fork
5. Submit a pull request from your repo to the `main` branch of `mindsdb/lightwood` so that we can review your changes. Be sure to merge the latest from main before making a pull request!

> Note: You will need to sign a CLI agreement for the code since lightwood is under a GPL license.
Expand All @@ -191,7 +190,7 @@ To get updates on Lightwood and MindsDB’s latest announcements, releases, and
Join our mission of democratizing machine learning and allowing developers to become data scientists!

## Contributor Code of Conduct
Please note that this project is released with a [Contributor Code of Conduct](https://github.com/mindsdb/lightwood/blob/stable/CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.
Please note that this project is released with a [Contributor Code of Conduct](https://github.com/mindsdb/lightwood/blob/main/CODE_OF_CONDUCT.md). By participating in this project, you agree to abide by its terms.


# Current contributors
Expand Down
2 changes: 1 addition & 1 deletion docssrc/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
## Compiling the docs
- Make sure you are in `docssrc`, then follow the instructions under `run` in our [documentation building github actions job](https://github.com/mindsdb/lightwood/blob/staging/.github/workflows/doc_build.yml#L21)
- Make sure you are in `docssrc`, then follow the instructions under `run` in our [documentation building github actions job](https://github.com/mindsdb/lightwood/blob/main/.github/workflows/doc_build.yml#L21)
- Then go into the newly build docs and start a server to see them: `cd ../docs && python3 -m http.server`
- Should now be available at: 0.0.0.0:8000 | Alternatively, you can just open the `index.html` with a browser and that should work too

Expand Down
11 changes: 5 additions & 6 deletions docssrc/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -151,11 +151,10 @@ Code contributions
In general, we follow the `fork-and-pull <https://docs.github.com/en/github/collaborating-with-pull-requests/getting-started/about-collaborative-development-models#fork-and-pull-model>`_ git workflow. Here are the steps:

1. Fork the Lightwood repository
2. Checkout the ``staging`` branch, which is the development version that gets released weekly (there can be exceptions, but make sure to ask and confirm with us).
3. Make changes and commit them
4. Make sure that the CI tests pass. You can run the test suite locally with ``flake8 .`` to check style and ``python -m unittest discover tests`` to run the automated tests. This doesn't guarantee it will pass remotely since we run on multiple envs, but should work in most cases.
5. Push your local branch to your fork
6. Submit a pull request from your repo to the ``staging`` branch of ``mindsdb/lightwood`` so that we can review your changes. Be sure to merge the latest from staging before making a pull request!
2. Make changes and commit them
3. Make sure that the CI tests pass. You can run the test suite locally with ``flake8 .`` to check style and ``python -m unittest discover tests`` to run the automated tests. This doesn't guarantee it will pass remotely since we run on multiple envs, but should work in most cases.
4. Push your local branch to your fork
5. Submit a pull request from your repo to the ``main`` branch of ``mindsdb/lightwood`` so that we can review your changes. Be sure to merge the latest from main before making a pull request!

.. note:: You will need to sign a CLI agreement for the code since lightwood is under a GPL license.

Expand Down Expand Up @@ -190,7 +189,7 @@ Join our mission of democratizing machine learning and allowing developers to be

Contributor Code of Conduct
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Please note that this project is released with a `Contributor Code of Conduct <https://github.com/mindsdb/lightwood/blob/stable/CODE_OF_CONDUCT.md>`_. By participating in this project, you agree to abide by its terms.
Please note that this project is released with a `Contributor Code of Conduct <https://github.com/mindsdb/lightwood/blob/main/CODE_OF_CONDUCT.md>`_. By participating in this project, you agree to abide by its terms.


Current contributors
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -297,7 +297,7 @@
"load_custom_module('model_correlation.py')\n",
"\n",
"# read dataset\n",
"df = pd.read_csv('https://raw.githubusercontent.com/mindsdb/lightwood/stable/tests/data/hdi.csv')\n",
"df = pd.read_csv('https://raw.githubusercontent.com/mindsdb/lightwood/main/tests/data/hdi.csv')\n",
"\n",
"# define the predictive task\n",
"pdef = ProblemDefinition.from_dict({\n",
Expand Down

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"outputs": [],
"source": [
"# Load data\n",
"df = pd.read_csv('https://raw.githubusercontent.com/mindsdb/lightwood/staging/tests/data/concrete_strength.csv')\n",
"df = pd.read_csv('https://raw.githubusercontent.com/mindsdb/lightwood/main/tests/data/concrete_strength.csv')\n",
"\n",
"df = df.sample(frac=1, random_state=1)\n",
"train_df = df[:int(0.1*len(df))]\n",
Expand Down

0 comments on commit e342d65

Please sign in to comment.