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

Move getting started & .env to each project #20

Merged
merged 2 commits into from
Oct 26, 2023

Conversation

nicolewhite
Copy link
Contributor

Changed my mind, I think it makes more sense for each example to have a self contained README instead of asking people to go look at the main README first. Also makes it easier to link directly to an example

@vercel
Copy link

vercel bot commented Oct 26, 2023

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
autoblocks-examples ✅ Ready (Inspect) Visit Preview Oct 26, 2023 1:07pm

@review-agent-prime
Copy link

The changes in this PR are mostly about updating the README files and the CI workflow. Here are some suggestions:

  1. In the ci.yml file, you have duplicated the Checkout repository and Setup Node steps in the test-readmes-up-to-date job. You should remove the duplicates to keep the workflow clean and efficient.

  2. In the ci.yml file, you have duplicated the project matrix in the test-python and test-javascript jobs. You should remove the duplicates to keep the workflow clean and efficient.

  3. In the ci.yml file, the working-directory for the Install dependencies and Run script steps in the test-python and test-javascript jobs is now set globally for each job. Make sure that this doesn't affect the correct execution of these steps.

  4. In the make-readmes.js file, you are replacing the content between the getting started start and getting started end comments with the GETTING_STARTED constant. Make sure that all README files have these comments, otherwise the replaceContentBetweenComments function will return the original content.

Here are the code suggestions for the first two points:

## .github/workflows/ci.yml

 jobs:
   test-readmes-up-to-date:
     runs-on: ubuntu-latest
     steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Setup Node
        uses: actions/setup-node@v3

-     - name: Checkout repository
-       uses: actions/checkout@v4

-     - name: Setup Node
-       uses: actions/setup-node@v3

...

   test-python:
    runs-on: ubuntu-latest

    strategy:
      matrix:
        project:
          - Python/langchain
          - Python/openai-manual
          - Python/openai-automated

-    strategy:
-      matrix:
-        project:
-          - Python/langchain
-          - Python/openai-manual
-          - Python/openai-automated

...

   test-javascript:
     runs-on: ubuntu-latest

    strategy:
      matrix:
        project:
          - JavaScript/langchain
          - JavaScript/openai-automated
          - JavaScript/openai-manual

-    strategy:
-      matrix:
-        project:
-          - JavaScript/langchain
-          - JavaScript/openai-automated
-          - JavaScript/openai-manual

@nicolewhite nicolewhite merged commit 0843e47 into main Oct 26, 2023
9 checks passed
@nicolewhite nicolewhite deleted the move-env-instructions-to-each-project-readme branch October 26, 2023 13:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant