Merge pull request #40 from scoredetect/release/1.7.0

Release/1.7.0

CHANGELOG.md

@@ -13,6 +13,12 @@ All notable changes to this project will be documented in this file, per [the Ke
 ### Security
 -->
 
+<!-- ... -->
+## [1.7.0] - 2024-08-30
+
+### Changed
+* Refactored Screenshot HUD to appear in the screenshot by @michael-sumner in #38
+
 <!-- ... -->
 ## [1.6.0] - 2024-08-19
 
@@ -99,6 +105,7 @@ All notable changes to this project will be documented in this file, per [the Ke
 - Initial plugin release
 
 [Unreleased]: https://github.com/scoredetect/timestamps/compare/trunk...develop
+[1.7.0]: https://github.com/scoredetect/timestamps/compare/1.6.0...1.7.0
 [1.6.0]: https://github.com/scoredetect/timestamps/compare/1.5.0...1.6.0
 [1.5.0]: https://github.com/scoredetect/timestamps/compare/1.4.1...1.5.0
 [1.4.1]: https://github.com/scoredetect/timestamps/compare/1.4.0...1.4.1

CONTRIBUTING.md

@@ -26,11 +26,11 @@ The `develop` branch is the development branch which means it contains the next
 
 ## Release instructions
 
-Open a [new blank issue](https://github.com/scoredetect/timestamps/issues/new) with `[Release] 1.5.0`, then copy and paste the following items, replacing version numbers and links to the milestone.
+Open a [new blank issue](https://github.com/scoredetect/timestamps/issues/new) with `[Release] 1.7.0`, then copy and paste the following items, replacing version numbers and links to the milestone.
 
-- [ ] 1. Branch: Starting from `develop`, cut a release branch named `release/1.5.0` for your changes.
+- [ ] 1. Branch: Starting from `develop`, cut a release branch named `release/1.7.0` for your changes.
 - [ ] 2. Version bump: Bump the version number in `timestamps.php`, `package.json`, `package-lock.json`, `readme.txt`, and any other relevant files if it does not already reflect the version being released. In `timestamps.php` update both the plugin "Version:" property and the plugin `SDCOM_TIMESTAMPS_VERSION` constant.
-- [ ] 3. Changelog: Add/update the changelog in `CHANGELOG.md`, ensuring to link the [1.5.0] release reference in the footer of `CHANGELOG.md` (e.g., https://github.com/scoredetect/timestamps/compare/1.5.0-1...1.5.0).
+- [ ] 3. Changelog: Add/update the changelog in `CHANGELOG.md`, ensuring to link the [1.7.0] release reference in the footer of `CHANGELOG.md` (e.g., https://github.com/scoredetect/timestamps/compare/1.7.0-1...1.7.0).
 - [ ] 4. Props: Update `CREDITS.md` file with any new contributors, confirm maintainers are accurate.
 - [ ] 5. Readme updates: Make any other readme changes as necessary. `README.md` is geared toward GitHub and `readme.txt` contains WordPress.org-specific content. The two are slightly different.
 - [ ] 6. New files: Check to be sure any new files/paths that are unnecessary in the production version are included in `.distignore`.
@@ -42,7 +42,7 @@ Open a [new blank issue](https://github.com/scoredetect/timestamps/issues/new) w
 - [ ] 12. [Check the _Build and Tag_ action](https://github.com/scoredetect/timestamps/actions/workflows/build-and-tag.yml): a new tag named with the version number should've been created. It should contain all the built assets.
 - [ ] 13. Release: Create a [new release](https://github.com/scoredetect/timestamps/releases/new):
   * **Tag**: The tag created in the previous step
-  * **Release title**: `Version 1.5.0`
+  * **Release title**: `Version 1.7.0`
   * **Description**: Release changelog from `CHANGELOG.md` + `See: https://github.com/scoredetect/timestamps/milestone/#?closed=1`
 - [ ] 14. SVN: Wait for the [GitHub Action](https://github.com/scoredetect/timestamps/actions/workflows/push-deploy.yml) to finish deploying to the WordPress.org repository. If all goes well, users with SVN commit access for that plugin will receive an emailed diff of changes.
 - [ ] 15. Check WordPress.org: Ensure that the changes are live on https://wordpress.org/plugins/timestamps/. This may take a few minutes.
@@ -51,9 +51,9 @@ Open a [new blank issue](https://github.com/scoredetect/timestamps/issues/new) w
 
 There may be cases where we have an urgent/important fix that ideally gets into a release quickly without any other changes (e.g., a "hotfix") so as to reduce (1) the amount or testing before being confident in the release and (2) to reduce the chance of unintended side effects from the extraneous non-urgent/important changes.  In cases where code has previously been merged into `develop` but that ideally is not part of a hotfix, the normal release instructions above will not suffice as they would release all code merged to `develop` alongside the intended urgent/important "hotfix" change(s).  In case of needing to release a "hotfix" the following are the recommended steps to take.
 
-1. Branch: Starting from `main`, cut a hotfix release branch named `hotfix/1.5.0` for your hotfix change(s).
+1. Branch: Starting from `main`, cut a hotfix release branch named `hotfix/1.7.0` for your hotfix change(s).
 1. Version bump: Bump the version number in `timestamps.php`, `package.json`, `readme.txt`, and any other relevant files if it does not already reflect the version being released.  In `timestamps.php` update both the plugin "Version:" property and the plugin `SDCOM_TIMESTAMPS_VERSION` constant.
-1. Changelog: Add/update the changelog in `CHANGELOG.md` and `readme.txt`, ensuring to link the [1.5.0] release reference in the footer of `CHANGELOG.md` (e.g., https://github.com/scoredetect/timestamps/compare/1.5.0-1...1.5.0).
+1. Changelog: Add/update the changelog in `CHANGELOG.md` and `readme.txt`, ensuring to link the [1.7.0] release reference in the footer of `CHANGELOG.md` (e.g., https://github.com/scoredetect/timestamps/compare/1.7.0-1...1.7.0).
 1. Props: Update `CREDITS.md` file with any new contributors, confirm maintainers are accurate.
 1. Readme updates: Make any other readme changes as necessary.  `README.md` is geared toward GitHub and `readme.txt` contains WordPress.org-specific content.  The two are slightly different.
 1. New files: Check to be sure any new files/paths that are unnecessary in the production version are included in `.distignore`.

includes/classes/Feature/Timestamp/Screenshot.php

@@ -190,9 +190,9 @@ public function ajax_sdcom_timestamps_screenshot() {
 	}
 
 	/**
-	 * AJAX handler for generating the screenshot timestamp hash.
+	 * AJAX handler for generating the screenshot certificate id.
 	 *
-	 * @since 1.5.0
+	 * @since 1.7.0
 	 */
 	public function ajax_sdcom_timestamps_screenshot_generate_certificate_id() {
 
@@ -213,7 +213,7 @@ public function ajax_sdcom_timestamps_screenshot_generate_certificate_id() {
 
 		// Handle the case where the method returned false.
 		if ( $generate_certificate_id === false ) {
-			throw new \Exception( 'Generate checksum failed.' );
+			throw new \Exception( 'Generate certificate ID failed.' );
 		}
 
 		if ( empty( $generate_certificate_id->{'uuid'} ) ) {
@@ -252,7 +252,7 @@ public function shortcode(): string {
 	/**
 	 * Creates a certificate for a file.
 	 *
-	 * @since 1.5.0
+	 * @since 1.7.0
 	 *
 	 * @param File   $file The file to create a certificate for.
 	 * @param string $id The id of the certificate to create. Optional.
@@ -361,7 +361,7 @@ private function create_certificate( $file, $id = '' ) {
 	/**
 	 * Generates a unique certificate ID for use.
 	 *
-	 * @since 1.5.0
+	 * @since 1.7.0
 	 *
 	 * @return object|false The data returned by the API on success, or false on failure.
 	 * @throws \Throwable If an exception occurs during the process.

package.json

@@ -1,6 +1,6 @@
 {
   "name": "timestamps-plugin",
-  "version": "1.6.0",
+  "version": "1.7.0",
   "description": "Timestamp your WordPress content to empower your content authenticity and increase user trust with our blockchain timestamping solution.",
   "homepage": "https://www.scoredetect.com/",
   "repository": {

readme.txt

@@ -4,7 +4,7 @@ Tags: timestamp, blockchain, content, authenticity, copyright
 Requires at least: 6.0.0
 Tested up to: 6.6.1
 Requires PHP: 7.4
-Stable tag: 1.6.0
+Stable tag: 1.7.0
 License: AGPL-3.0-only
 License URI: https://spdx.org/licenses/AGPL-3.0-only.html
 
@@ -31,7 +31,7 @@ __Gutenberg / Block Editor Ready__: We aim for the latest technology. The plugin
 
 __Classic Editor Ready__: The plugin is also ready for the __Classic Editor__, so you can use it with the editor you prefer.
 
-__Screenshots Button__: Allow your users to easily timestamp their screenshots by adding a `[timestamps_screenshot]` shortcode button.
+__Screenshots Button__: Allow your users to easily timestamp their screenshots by adding a `[timestamps_screenshot]` shortcode button. Each screenshot is unique with a QR code, date/time, and certificate ID.
 
 __Privacy Protection__: We strive for privacy, therefore __only administrators__ with the __manage_options__ capability can have access to perform actions with this plugin.
 

timestamps.php

@@ -8,13 +8,13 @@
  * that starts the plugin.
  *
  * @link              https://www.scoredetect.com/
- * @since             1.6.0
+ * @since             1.7.0
  * @package           SDCOM_Timestamps
  *
  * @wordpress-plugin
  * Plugin Name:       Timestamps
  * Description:       Timestamp your WordPress content to empower your content authenticity and increase user trust. No blockchain skills needed.
- * Version:           1.6.0
+ * Version:           1.7.0
  * Author:            ScoreDetect.com
  * Author URI:        https://www.scoredetect.com/
  * License:           AGPL-3.0-only
@@ -31,7 +31,7 @@
 }
 
 // Useful global constants.
-define( 'SDCOM_TIMESTAMPS_VERSION', '1.6.0' );
+define( 'SDCOM_TIMESTAMPS_VERSION', '1.7.0' );
 define( 'SDCOM_TIMESTAMPS_OPTIONS', 'sdcom_timestamps' );
 define( 'SDCOM_TIMESTAMPS_URL', plugin_dir_url( __FILE__ ) );
 define( 'SDCOM_TIMESTAMPS_PATH', plugin_dir_path( __FILE__ ) );