{"id":13505655,"url":"https://github.com/aws-samples/aws-cdk-changelogs-demo","last_synced_at":"2025-03-30T00:31:21.154Z","repository":{"id":34334082,"uuid":"176996794","full_name":"aws-samples/aws-cdk-changelogs-demo","owner":"aws-samples","description":"This is a demo application that uses modern serverless architecture to crawl changelogs from open source projects, parse them, and provide an API and website for viewing them.","archived":true,"fork":false,"pushed_at":"2023-07-13T07:46:28.000Z","size":6066,"stargazers_count":277,"open_issues_count":8,"forks_count":44,"subscribers_count":15,"default_branch":"master","last_synced_at":"2024-11-01T03:32:41.773Z","etag":null,"topics":["aws","aws-fargate","aws-lambda","nodejs","serverless"],"latest_commit_sha":null,"homepage":"https://changelogs.md","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit-0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aws-samples.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null}},"created_at":"2019-03-21T17:51:03.000Z","updated_at":"2024-08-29T21:52:55.000Z","dependencies_parsed_at":"2024-01-06T10:14:11.126Z","dependency_job_id":"2b8a73c8-4b95-44ac-acb7-db37de5fbb55","html_url":"https://github.com/aws-samples/aws-cdk-changelogs-demo","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aws-samples%2Faws-cdk-changelogs-demo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aws-samples%2Faws-cdk-changelogs-demo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aws-samples%2Faws-cdk-changelogs-demo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aws-samples%2Faws-cdk-changelogs-demo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aws-samples","download_url":"https://codeload.github.com/aws-samples/aws-cdk-changelogs-demo/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246262490,"owners_count":20749170,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws","aws-fargate","aws-lambda","nodejs","serverless"],"created_at":"2024-08-01T00:01:11.218Z","updated_at":"2025-03-30T00:31:16.142Z","avatar_url":"https://github.com/aws-samples.png","language":"JavaScript","funding_links":[],"categories":["Training Materials and Sample Code","JavaScript"],"sub_categories":["Multi-accounts setup"],"readme":"# changelogs.md\n\nThis is an open source application designed to showcase the usage of modern\nserverless compute platforms such as [AWS Lambda](https://aws.amazon.com/lambda/)\nand [AWS Fargate](https://aws.amazon.com/blogs/aws/aws-fargate/). It is built\nand deployed using the [AWS Cloud Development Kit (CDK)](https://docs.aws.amazon.com/CDK/latest/userguide/what-is.html)\n\nThis application is a Github changelog crawler and parser. It follows the [NPM](https://www.npmjs.com/), [PyPI](https://pypi.org/), and [RubyGems](https://rubygems.org/)\npackage registries to watch for newly published code, then checks the Github\nfor each package for changelog files, parses the file, and then exposes both\na human readable HTML and machine readable JSON file with the changelog content.\n\n![architecture diagram](/docs/architecture.png)\n\nFor a full explanation of this architecture see the [/docs](/docs) folder\n\n### Development Environment\n\nThis application is coded, built, and deployed using [node.js](https://nodejs.org/en/).\nYou will need to ensure that Node 9.0.0+ is installed on your local machine.\n\nAdditionally [Docker](https://www.docker.com/) is used for building the\nimages that get run in AWS Fargate.\n\nIn order to deploy the application you need to first setup the development\nenvironment with all the dependencies:\n\n```bash\nnpm run-script setup\n```\n\nThis will install the right version of the AWS CDK locally to this project,\nas well as all the CDK dependencies necessary to construct the application.\nIt will also install the NPM dependencies that the application needs at\nruntime. The next step is to deploy the app onto your AWS account:\n\n```bash\nnpm run-script deploy\n```\n\nDeploying from scratch typically takes around 30 minutes (most of which is\nspent on a CloudFront distribution rollout). While you wait you can\ncheck out [the CDK app](/changelogs-md.js) that defines all the infrastructure.\n\nIf you want to see ahead of time what CloudFormation templates will be deployed\nthen run:\n\n```bash\nnpm run-script synth\n```\n\nThen check the contents of the `/synth` folder that is generated. You will find\nseveral thousands lines of generated CloudFormation template defining the\nunderlying resources of the application stack.\n\nIf you want to change part of the application and redeploy just that part\nyou can do so with a command like:\n\n```bash\n./node_modules/.bin/cdk deploy crawler\n```\n\n### Github Access Token\n\nThis application uses the Github API to discover changelogs in repositories.\nFor a less limited Github API access you need to configure an access token:\n\n1) Generate a Github access token for yourself: https://github.com/settings/tokens\n2) Put the token in to `/secrets/github-access-token.json`:\n\n```json\n{\n  \"token\": \"\u003cyour personal access token\u003e\"\n}\n```\n\n### Domain name and SSL\n\nYou will need to supply you own domain name and SSL cert if you want to deploy\nthe site. The configuration should be put in a file `settings.json` in the root\nof the repo:\n\n```\n{\n  \"names\": [\n    \"\u003cyour (sub)domain name\"\n  ],\n  \"acmCertRef\": \"\u003cyour cert arn\u003e\"\n}\n```\n\n### Cleanup\n\nTo destroy any resources you have created for this example:\n\n```bash\nnpm run-script destroy\n```\n\n## License Summary\n\n This sample code is made available under a modified MIT license.\n See the LICENSE file.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faws-samples%2Faws-cdk-changelogs-demo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faws-samples%2Faws-cdk-changelogs-demo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faws-samples%2Faws-cdk-changelogs-demo/lists"}