diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index 8e53905..bcb1699 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -40,7 +40,7 @@ jobs: # Initializes the CodeQL tools for scanning. - name: Initialize CodeQL - uses: github/codeql-action/init@v1 + uses: github/codeql-action/init@v2 with: languages: ${{ matrix.language }} # If you wish to specify custom queries, you can do so here or in a config file. @@ -51,7 +51,7 @@ jobs: # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). # If this step fails, then you should remove it and run the build manually (see below) - name: Autobuild - uses: github/codeql-action/autobuild@v1 + uses: github/codeql-action/autobuild@v2 # ℹī¸ Command-line programs to run using the OS shell. # 📚 https://git.io/JvXDl @@ -65,4 +65,4 @@ jobs: # make release - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@v1 + uses: github/codeql-action/analyze@v2 diff --git a/README.md b/README.md index 8f679b2..4d48dd5 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,6 @@ [![NPM Publish](https://github.com/seantomburke/sitemapper/actions/workflows/npm-publish.yml/badge.svg)](https://github.com/seantomburke/sitemapper/actions/workflows/npm-publish.yml) [![Version Bump](https://github.com/seantomburke/sitemapper/actions/workflows/version-bump.yml/badge.svg?branch=master&event=push)](https://github.com/seantomburke/sitemapper/actions/workflows/version-bump.yml) [![Test](https://github.com/seantomburke/sitemapper/actions/workflows/test.yml/badge.svg?branch=master&event=push)](https://github.com/seantomburke/sitemapper/actions/workflows/test.yml) -[![Build Status](https://travis-ci.org/seantomburke/sitemapper.svg?branch=master)](https://travis-ci.org/seantomburke/sitemapper) [![Codecov](https://img.shields.io/codecov/c/github/seantomburke/sitemapper?token=XhiEgaHFWL)](https://codecov.io/gh/seantomburke/sitemapper) [![CodeFactor](https://www.codefactor.io/repository/github/seantomburke/sitemapper/badge)](https://www.codefactor.io/repository/github/seantomburke/sitemapper) [![GitHub license](https://img.shields.io/github/license/seantomburke/sitemapper)](https://github.com/seantomburke/sitemapper/blob/master/LICENSE) @@ -82,13 +81,24 @@ You can add options on the initial Sitemapper object when instantiating it. - `rejectUnauthorized`: (Boolean) - If true, it will throw on invalid certificates, such as expired or self-signed ones. Default: True - `lastmod`: (Number) - Timestamp of the minimum lastmod value allowed for returned urls - `proxyAgent`: (HttpProxyAgent|HttpsProxyAgent) - instance of npm "hpagent" HttpProxyAgent or HttpsProxyAgent to be passed to npm "got" -- `field` : (Object) - An object of fields to be returned from the sitemap. +- `exclusions`: (Array) - Array of regex patterns to exclude URLs from being processed +- `field`: (Object) - An object of fields to be returned from the sitemap. Leaving a field out has the same effect as `: false`. If not specified sitemapper defaults to returning the 'classic' array of urls. Available fields: + - `loc`: (Boolean) - The URL location of the page + - `lastmod`: (Boolean) - The date of last modification of the page + - `changefreq`: (Boolean) - How frequently the page is likely to change + - `priority`: (Boolean) - The priority of this URL relative to other URLs on your site + - `image:loc`: (Boolean) - The URL location of the image (for image sitemaps) + - `image:title`: (Boolean) - The title of the image (for image sitemaps) + - `image:caption`: (Boolean) - The caption of the image (for image sitemaps) + - `video:title`: (Boolean) - The title of the video (for video sitemaps) + - `video:description`: (Boolean) - The description of the video (for video sitemaps) + - `video:thumbnail_loc`: (Boolean) - The thumbnail URL of the video (for video sitemaps) For Example: ``` -{ +field: { loc: true, lastmod: true, changefreq: true,